Skip to content

Commit

Permalink
Merge pull request #31 from jonataswalker/clean-up
Browse files Browse the repository at this point in the history
remove unused files & add release-it
  • Loading branch information
jonataswalker committed Feb 28, 2024
2 parents 99748f6 + 05ec51b commit 838a2f4
Show file tree
Hide file tree
Showing 7 changed files with 7,826 additions and 4,641 deletions.
3 changes: 0 additions & 3 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1,4 +1 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npm run lint
6 changes: 0 additions & 6 deletions .npmignore

This file was deleted.

12 changes: 0 additions & 12 deletions .prettierrc

This file was deleted.

2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"editor.rulers": [100, 120],
"editor.formatOnPaste": false,
"editor.guides.bracketPairs": true,
"eslint.experimental.useFlatConfig": true,
"editor.bracketPairColorization.enabled": true,
"editor.guides.bracketPairs": true,
"typescript.tsdk": "node_modules/typescript/lib",
"javascript.updateImportsOnFileMove.enabled": "always",
"search.exclude": {
Expand Down
45 changes: 8 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,53 +5,24 @@ Shareable ESLint config
## Install

```sh
# flat config
npm i -D eslint-config-jwalker

# classic config
npm i -D eslint-config-jwalker@8
```

## Usage - Flat Config
## Usage

```javascript
import tsParser from '@typescript-eslint/parser'
import dwEslintConfig from '@deepwaterv2/eslint-config'
import { common, typescript, node } from 'eslint-config-jwalker'

/** @type {import('eslint').Linter.FlatConfig[]} */
export default [
...dwEslintConfig,
{ ignores: ['types/*', 'scripts/*', '**/*.d.ts'] },
...common,
...node,
...typescript,
{
languageOptions: {
parser: tsParser,
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.eslint.json'],
},
rules: {
// override?
'import/extensions': 'off',
},
},
]
```


## Usage

Shareable configs are designed to work with the `extends` feature of `.eslintrc` files.
You can learn more about
[Shareable Configs](http://eslint.org/docs/developer-guide/shareable-configs) on the
official ESLint website.

Add this to your `.eslintrc` file (or `package.json`):

```json
{
"extends": "jwalker"
}
```

_Note: We omitted the `eslint-config-` prefix since it is automatically assumed by ESLint._

You can override settings from the shareable config by adding them directly into your
`.eslintrc` file.

0 comments on commit 838a2f4

Please sign in to comment.