Skip to content

Commit

Permalink
Merge branch 'release-0.1.3'
Browse files Browse the repository at this point in the history
  • Loading branch information
krampstudio committed Feb 24, 2021
2 parents e2590da + f68b5d9 commit 4e25e25
Show file tree
Hide file tree
Showing 4 changed files with 265 additions and 8 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Shareable `.eslintrc` configurations package for `oat-sa` projects.

## Concept

All extensions, projects and libraries under (`oat-sa` wide) should use the shared config as a basis.
All extensions, projects and libraries (`oat-sa` wide) should use the shared config as a basis.
Current extension contains a pack of shareable configs depending on the stack and target.
General idea is described here: [https://eslint.org/docs/developer-guide/shareable-configs]()

Expand All @@ -13,29 +13,34 @@ General idea is described here: [https://eslint.org/docs/developer-guide/shareab
Use shareable eslint configurations via the `extends` config property.

1. Default configuration. Edit the `.eslintrc.js` of your project:

```javascript
module.exports = {
extends: "@oat-sa/eslint-config-tao"
}
```

2. Configuration for AMD modules:

```javascript
module.exports = {
extends: "@oat-sa/eslint-config-tao/amd"
}
```
Recommended pligins to be installed:

Recommended plugins to be installed:
- `eslint-plugin-es`
- `eslint-plugin-jsdoc`

3. Configuration for es modules, svelte, etc.:

```javascript
module.exports = {
extends: "@oat-sa/eslint-config-tao/svelte"
}
```
Recommended pligins to be installed:

Recommended plugins to be installed:
- `eslint-plugin-es`
- `eslint-plugin-jsdoc`
- `eslint-plugin-jest`
Expand All @@ -44,5 +49,5 @@ Use shareable eslint configurations via the `extends` config property.
If you forget about recommended eslint plugins, you'll get a warning with the proper versions to install.
## Release history
* _0.1.0_ Initial release.
- _0.1.0_ Initial release.
252 changes: 250 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@oat-sa/eslint-config-tao",
"version": "0.1.2",
"version": "0.1.3",
"description": "Shareable `.eslintrc` configurations package for `oat-sa` projects.",
"main": "index.js",
"scripts": {},
Expand All @@ -25,6 +25,9 @@
"publishConfig": {
"access": "public"
},
"dependencies": {
"babel-eslint": "^10.1.0"
},
"peerDependencies": {
"eslint-plugin-es": ">=3.0.0",
"eslint-plugin-jsdoc": ">=20.3.0"
Expand Down
1 change: 1 addition & 0 deletions svelte.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ module.exports = {
'jest/globals': true
},
plugins: ['es', 'jsdoc', 'svelte3', 'jest'],
parser: 'babel-eslint',
parserOptions: {
sourceType: 'module',
ecmaVersion: 2015
Expand Down

0 comments on commit 4e25e25

Please sign in to comment.