diff --git a/CHANGELOG.md b/CHANGELOG.md index 46fa451..bb3f59f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # CHANGELOG +## 11.0.0-alpha.7 - Mar 7 2023 + +- Update JSDoc rules +- Update JSON plugin to be used for json files. This also make the default linting experience actually lint json files without specifying any extensions. See . + ## 11.0.0-alpha.6 - Mar 1 2023 - Disable no-restricted-exports because we need to be able to export default diff --git a/jsdoc.js b/jsdoc.js index 080ea12..51c9190 100644 --- a/jsdoc.js +++ b/jsdoc.js @@ -1,31 +1,29 @@ module.exports = { plugins: ['jsdoc'], - rules: { - 'jsdoc/check-alignment': 'warn', - 'jsdoc/check-examples': 'warn', - 'jsdoc/check-indentation': 'off', - 'jsdoc/check-param-names': 'warn', - 'jsdoc/check-syntax': 'warn', - 'jsdoc/check-tag-names': 'warn', - 'jsdoc/check-types': 'warn', - 'jsdoc/implements-on-classes': 'warn', - 'jsdoc/match-description': 'warn', - 'jsdoc/newline-after-description': 'off', - 'jsdoc/no-types': 'off', - 'jsdoc/no-undefined-types': 'warn', - 'jsdoc/require-description-complete-sentence': 'off', - 'jsdoc/require-description': 'warn', - 'jsdoc/require-example': 'off', - 'jsdoc/require-hyphen-before-param-description': 'warn', - 'jsdoc/require-jsdoc': 'warn', - 'jsdoc/require-param-description': 'warn', - 'jsdoc/require-param-name': 'warn', - 'jsdoc/require-param-type': 'warn', - 'jsdoc/require-param': 'warn', - 'jsdoc/require-returns-check': 'warn', - 'jsdoc/require-returns-description': 'warn', - 'jsdoc/require-returns-type': 'warn', - 'jsdoc/require-returns': 'warn', - 'jsdoc/valid-types': 'warn', - }, + overrides: [ + { + files: ['*.js?(x)', '*.html'], + rules: { + 'valid-jsdoc': 'warn', + 'jsdoc/check-alignment': 'warn', + 'jsdoc/check-param-names': 'warn', + 'jsdoc/check-syntax': 'warn', + 'jsdoc/check-tag-names': 'warn', + 'jsdoc/check-types': 'warn', + 'jsdoc/implements-on-classes': 'warn', + 'jsdoc/match-description': 'warn', + 'jsdoc/require-description': 'warn', + 'jsdoc/require-hyphen-before-param-description': 'warn', + 'jsdoc/require-param-description': 'warn', + 'jsdoc/require-param-name': 'warn', + 'jsdoc/require-param-type': 'warn', + 'jsdoc/require-param': 'warn', + 'jsdoc/require-returns-check': 'warn', + 'jsdoc/require-returns-description': 'warn', + 'jsdoc/require-returns-type': 'warn', + 'jsdoc/require-returns': 'warn', + 'jsdoc/valid-types': 'warn', + }, + }, + ], } diff --git a/json.js b/json.js index 90ca0c6..555b409 100644 --- a/json.js +++ b/json.js @@ -1,3 +1,3 @@ module.exports = { - extends: ['plugin:json/recommended-with-comments'], + overrides: [{ files: ['*.json'], extends: ['plugin:json/recommended-with-comments'] }], } diff --git a/package.json b/package.json index dfa22d5..83a4907 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fs/eslint-config-frontier-react", - "version": "11.0.0-alpha.6", + "version": "11.0.0-alpha.7", "description": "A common ESLint configuration setup for frontier apps", "main": "index.js", "engines": {