@1stg/eslint-config 5.3.0 → 5.4.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## 5.4.1
+
+### Patch Changes
+
+- [#131](https://github.com/1stG/configs/pull/131) [`1e06825`](https://github.com/1stG/configs/commit/1e068259c54b12751960dbdc8acaa07949134f0f) Thanks [@JounQin](https://github.com/JounQin)! - fix(eslint): disable prettier/prettier rule for md/mdx automatically
+
+## 5.4.0
+
+### Minor Changes
+
+- [#128](https://github.com/1stG/configs/pull/128) [`7228ebb`](https://github.com/1stG/configs/commit/7228ebb1d2a31b5a305258dff24b0d0ca357ad4f) Thanks [@JounQin](https://github.com/JounQin)! - feat: support `CONFIG_PREFER_PRETTIER` env
+
+### Patch Changes
+
+- Updated dependencies [[`7228ebb`](https://github.com/1stG/configs/commit/7228ebb1d2a31b5a305258dff24b0d0ca357ad4f)]:
+  - @1stg/config@0.2.0
+
+## 5.3.1
+
+### Patch Changes
+
+- [#126](https://github.com/1stG/configs/pull/126) [`48d7542`](https://github.com/1stG/configs/commit/48d754293d6d68094792df71d56e8d7e8fc088a8) Thanks [@JounQin](https://github.com/JounQin)! - fix: support more `markup` files
+
 ## 5.3.0
 
 ### Minor Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 1stG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/_util.js

@@ -1,5 +1,6 @@
 const path = require('node:path')
 
+const { preferPrettier } = require('@1stg/config')
 const {
   isMonorepo,
   isPkgAvailable,
@@ -43,3 +44,7 @@ exports.magicNumbers = [
   -1, 0, 1, 2, 3, 5, 7, 10, 12, 15, 20, 24, 30, 31, 50, 60, 100, 365, 366, 500,
   768, 1000, 1024, 3600, 4200, 8080,
 ]
+
+exports.prettierExtends = preferPrettier
+  ? ['prettier']
+  : ['plugin:prettier/recommended']

package/base.js

@@ -1,7 +1,12 @@
 const { isTsAvailable } = require('@pkgr/utils')
 const { getGlobals } = require('eslint-plugin-mdx')
 
-const { isWebpackAvailable, magicNumbers, webpackSpecVars } = require('./_util')
+const {
+  isWebpackAvailable,
+  magicNumbers,
+  webpackSpecVars,
+  prettierExtends,
+} = require('./_util')
 
 module.exports = {
   extends: [
@@ -16,7 +21,7 @@ module.exports = {
     isTsAvailable && 'plugin:sonar/recommended',
     'plugin:unicorn/recommended',
     'standard',
-    'plugin:prettier/recommended',
+    ...prettierExtends,
   ].filter(Boolean),
   plugins: ['es-x', 'simple-import-sort'],
   globals: isWebpackAvailable ? getGlobals(webpackSpecVars) : undefined,

package/overrides.js

@@ -1,6 +1,6 @@
 const path = require('node:path')
 
-const { jsoncFiles, nonJsonRcFiles } = require('@1stg/config')
+const { jsoncFiles, nonJsonRcFiles, preferPrettier } = require('@1stg/config')
 const {
   isAngularAvailable,
   isReactAvailable,
@@ -12,7 +12,7 @@ const {
   tryPkg,
 } = require('@pkgr/utils')
 
-const { magicNumbers } = require('./_util')
+const { magicNumbers, prettierExtends } = require('./_util')
 
 const configFile =
   tryFile(path.resolve('babel.config.js')) ||
@@ -92,7 +92,7 @@ const tsBase = {
     'plugin:@typescript-eslint/eslint-recommended',
     'plugin:@typescript-eslint/recommended',
     'plugin:import/typescript',
-    'prettier',
+    ...prettierExtends,
   ],
   settings: resolveSettings,
   rules: {
@@ -270,7 +270,7 @@ exports.dTs = {
 }
 
 const reactJsx = {
-  extends: ['standard-react', 'plugin:react/recommended', 'prettier'],
+  extends: ['standard-react', 'plugin:react/recommended', ...prettierExtends],
   settings: {
     react: {
       version: 'detect',
@@ -321,7 +321,7 @@ exports.reactTs = {
   },
 }
 
-const vueExtends = ['plugin:vue/recommended', 'prettier']
+const vueExtends = ['plugin:vue/recommended', ...prettierExtends]
 
 exports.vue = [
   {
@@ -346,6 +346,11 @@ exports.vue = [
   },
   {
     files: '*.vue',
+    extends: [
+      // eslint-disable-next-line sonarjs/no-duplicate-string
+      'plugin:markup/recommended',
+      ...vueExtends,
+    ],
     rules: {
       'no-unused-vars': 0,
       '@typescript-eslint/no-unused-vars': 0,
@@ -356,9 +361,10 @@ exports.vue = [
 const svelteBase = {
   files: '*.svelte',
   extends: [
+    'plugin:markup/recommended',
     'plugin:svelte/recommended',
     'plugin:svelte/prettier',
-    'plugin:prettier/recommended',
+    ...prettierExtends,
   ],
   rules: {
     'sonar/label-position': 0,
@@ -389,7 +395,7 @@ exports.angular = [
     extends: [
       'plugin:@angular-eslint/recommended',
       'plugin:@angular-eslint/template/process-inline-templates',
-      'prettier',
+      ...prettierExtends,
     ],
     rules: {
       '@angular-eslint/prefer-on-push-component-change-detection': 1,
@@ -400,6 +406,7 @@ exports.angular = [
     extends: [
       'plugin:@angular-eslint/template/recommended',
       'plugin:markup/recommended',
+      ...prettierExtends,
     ],
     parser: 'angular-eslint-template-parser',
     rules: {
@@ -409,47 +416,42 @@ exports.angular = [
           allowNullOrUndefined: true,
         },
       ],
-      'prettier/prettier': 0,
       'spaced-comment': 0,
     },
   },
+  {
+    files: '*inline-template-*.component.html',
+    rules: {
+      'unicorn/no-empty-file': 0,
+    },
+  },
+]
+
+exports.markup = [
   {
     files: '*.html',
-    excludedFiles: '*inline-template-*.component.html',
-    extends: ['prettier'],
+    extends: 'plugin:markup/recommended',
     rules: {
       'prettier/prettier': [
-        2,
+        preferPrettier ? 0 : 2,
         {
-          parser: 'angular',
+          parser: 'html',
         },
       ],
     },
   },
   {
-    files: '*inline-template-*.component.html',
-    rules: {
-      'unicorn/no-empty-file': 0,
-    },
+    files: '*.pug',
+    extends: ['plugin:markup/recommended', ...prettierExtends],
   },
 ]
 
-exports.html = {
-  files: '*.html',
-  extends: 'plugin:markup/recommended',
-  rules: {
-    'prettier/prettier': [
-      2,
-      {
-        parser: 'html',
-      },
-    ],
-  },
-}
-
 exports.md = {
   files: '*.md',
   extends: ['plugin:mdx/recommended'],
+  rules: {
+    'prettier/prettier': preferPrettier ? 0 : 2,
+  },
 }
 
 exports.mdx = {
@@ -457,6 +459,9 @@ exports.mdx = {
   extends: [...reactJsx.extends, 'plugin:mdx/recommended'],
   parserOptions: jsBase.parserOptions,
   settings: { ...reactJsx.settings, ...resolveSettings },
+  rules: {
+    'prettier/prettier': preferPrettier ? 0 : 2,
+  },
 }
 
 const nonSourceRules = {
@@ -546,9 +551,11 @@ exports.overrides = []
     isReactAvailable && exports.react,
     isReactAvailable && exports.reactHooks,
     isReactAvailable && exports.reactTs,
+    // The order matters, the later should to be preferred
+    exports.markup,
+    isAngularAvailable && exports.angular,
     isVueAvailable && exports.vue,
     isSvelteAvailable && exports.svelte,
-    isAngularAvailable ? exports.angular : exports.html,
     exports.md,
     exports.mdx,
     isPkgAvailable('jest') && exports.jest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@1stg/eslint-config",
-  "version": "5.3.0",
+  "version": "5.4.1",
   "description": "Personal but Shareable ESLint Configuration for all 1stG.me projects",
   "repository": "git+https://github.com/1stG/configs.git",
   "homepage": "https://github.com/1stG/configs/tree/master/packages/eslint-config",
@@ -45,10 +45,10 @@
     "eslint": ">=6.0.0"
   },
   "dependencies": {
-    "@1stg/config": "^0.1.0",
-    "@angular-eslint/eslint-plugin": "^14.0.0",
-    "@angular-eslint/eslint-plugin-template": "^14.0.0",
-    "@angular-eslint/template-parser": "^14.0.0",
+    "@1stg/config": "^0.2.0",
+    "@angular-eslint/eslint-plugin": "^14.0.2",
+    "@angular-eslint/eslint-plugin-template": "^14.0.2",
+    "@angular-eslint/template-parser": "^14.0.2",
     "@babel/eslint-parser": "^7.18.2",
     "@babel/eslint-plugin": "^7.17.7",
     "@pkgr/utils": "^2.3.0",
@@ -60,14 +60,14 @@
     "eslint-config-standard-jsx": "^11.0.0",
     "eslint-config-standard-react": "^11.0.1",
     "eslint-formatter-friendly": "^7.0.0",
-    "eslint-import-resolver-typescript": "^3.2.4",
+    "eslint-import-resolver-typescript": "^3.2.5",
     "eslint-plugin-css": "^0.6.0",
     "eslint-plugin-es-x": "^5.2.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^26.5.3",
     "eslint-plugin-jsdoc": "^39.3.3",
-    "eslint-plugin-json-schema-validator": "^3.1.3",
+    "eslint-plugin-json-schema-validator": "^3.2.0",
     "eslint-plugin-jsonc": "^2.3.1",
     "eslint-plugin-markup": "^0.10.0",
     "eslint-plugin-mdx": "^2.0.1",
@@ -82,11 +82,11 @@
     "eslint-plugin-sonarjs": "^0.13.0",
     "eslint-plugin-svelte": "^2.2.0",
     "eslint-plugin-toml": "^0.3.1",
-    "eslint-plugin-unicorn": "^43.0.0",
+    "eslint-plugin-unicorn": "^43.0.1",
     "eslint-plugin-vue": "^9.2.0",
     "eslint-plugin-yml": "^1.0.0"
   },
   "publishConfig": {
     "access": "public"
   }
-}
+}