@dpuse/eslint-config-dpuse 1.0.136 → 1.0.137
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +28 -2
- package/dist/index.js.map +1 -1
- package/package.json +4 -1
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAiBrC,6HAA6H;AAC7H,MAAM,WAAW,4BAA4B;IACzC,2CAA2C;IAC3C,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,4FAA4F;IAC5F,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,sGAAsG;IACtG,KAAK,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC;CAC9B;AAED,oFAAoF;AACpF,MAAM,WAAW,wBAAyB,SAAQ,IAAI,CAAC,4BAA4B,EAAE,OAAO,CAAC;IACzF,8FAA8F;IAC9F,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,6GAA6G;IAC7G,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,mHAAmH;IACnH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mIAAmI;IACnI,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAWD,2HAA2H;AAC3H,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,CAkG5F;AAED,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,MAAM,CAAC,MAAM,EAAE,CA+BpF;AAED,eAAe,iBAAiB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import pluginComments from '@eslint-community/eslint-plugin-eslint-comments';
|
|
2
2
|
import { flatConfigs as pluginImportFlatConfigs } from 'eslint-plugin-import-x';
|
|
3
|
+
import pluginJS from '@eslint/js';
|
|
4
|
+
import pluginJSDoc from 'eslint-plugin-jsdoc';
|
|
5
|
+
import pluginMarkdown from '@eslint/markdown';
|
|
3
6
|
import pluginN from 'eslint-plugin-n';
|
|
4
7
|
import { configs as pluginRegexpConfigs } from 'eslint-plugin-regexp';
|
|
5
8
|
import pluginSecurity from 'eslint-plugin-security';
|
|
@@ -9,7 +12,10 @@ import skipFormatting from 'eslint-config-prettier';
|
|
|
9
12
|
import tseslint from 'typescript-eslint';
|
|
10
13
|
import { defineConfig, globalIgnores } from 'eslint/config';
|
|
11
14
|
// ── Constants ────────────────────────────────────────────────────────────────────────────────────────────────────────
|
|
12
|
-
|
|
15
|
+
// Everything except code files, for 'ignores'. A block limited this way, rather than by 'files', keeps its rules off
|
|
16
|
+
// other languages without also telling ESLint to lint code files that the project's 'files' leave out.
|
|
17
|
+
const NON_CODE_FILES = ['**/*', '!**/*.{cjs,cts,js,jsx,mjs,mts,ts,tsx,vue}'];
|
|
18
|
+
const NON_TYPESCRIPT_FILES = ['**/*', '!**/*.{cts,mts,ts,tsx,vue}'];
|
|
13
19
|
// ── ESLint Configuration ─────────────────────────────────────────────────────────────────────────────────────────────
|
|
14
20
|
/** The rules, plugins, and ignores shared by every DPUse project, TypeScript or otherwise (e.g. dpuse-app's Vue setup). */
|
|
15
21
|
export function dpuseBaseESLintConfig(options) {
|
|
@@ -21,7 +27,7 @@ export function dpuseBaseESLintConfig(options) {
|
|
|
21
27
|
// (e.g. a '.mjs' script) still gets the DPUse settings, while a file in another language (e.g. '.css') gets none of
|
|
22
28
|
// these JavaScript rules, which ESLint refuses to run on it.
|
|
23
29
|
{
|
|
24
|
-
|
|
30
|
+
ignores: NON_CODE_FILES,
|
|
25
31
|
extends: [
|
|
26
32
|
{
|
|
27
33
|
// '@eslint-community/eslint-comments' only ships a legacy config; manually convert to flat format.
|
|
@@ -35,6 +41,10 @@ export function dpuseBaseESLintConfig(options) {
|
|
|
35
41
|
}
|
|
36
42
|
},
|
|
37
43
|
pluginImportFlatConfigs.recommended,
|
|
44
|
+
// Checks doc comments agree with the code they describe, without requiring one on every function. The
|
|
45
|
+
// TypeScript flavour forbids types in doc comments, which plain JavaScript files rely on, so it stops at
|
|
46
|
+
// TypeScript.
|
|
47
|
+
{ ...pluginJSDoc.configs['flat/logical-typescript'], ignores: NON_TYPESCRIPT_FILES },
|
|
38
48
|
{
|
|
39
49
|
plugins: { n: pluginN },
|
|
40
50
|
rules: {
|
|
@@ -71,6 +81,20 @@ export function dpuseBaseESLintConfig(options) {
|
|
|
71
81
|
'unicorn/text-encoding-identifier-case': ['error', { withDash: true }] // 'utf-8' is the standard name TextDecoder and chardet use, and Node accepts it too.
|
|
72
82
|
}
|
|
73
83
|
},
|
|
84
|
+
// Markdown files, such as each project's README. GitHub-flavoured, because that is where the READMEs are read. Front
|
|
85
|
+
// matter is the YAML block the knowledge-base pages open with, which would otherwise be read as Markdown.
|
|
86
|
+
{
|
|
87
|
+
files: ['**/*.md'],
|
|
88
|
+
extends: [pluginMarkdown.configs.recommended],
|
|
89
|
+
language: 'markdown/gfm',
|
|
90
|
+
languageOptions: { frontmatter: 'yaml' },
|
|
91
|
+
rules: {
|
|
92
|
+
// GitHub alert boxes ('> [!WARNING]') look like links to a label that is never defined.
|
|
93
|
+
'markdown/no-missing-label-refs': ['error', { allowLabels: ['!CAUTION', '!IMPORTANT', '!NOTE', '!TIP', '!WARNING'] }],
|
|
94
|
+
// A front matter 'title' names the browser tab, not a heading on the page, so a page may still open with '#'.
|
|
95
|
+
'markdown/no-multiple-h1': ['error', { frontmatterTitle: '' }]
|
|
96
|
+
}
|
|
97
|
+
},
|
|
74
98
|
// TypeScript and project rule overrides. Limited to 'files', where the TypeScript plugin is set up.
|
|
75
99
|
{
|
|
76
100
|
files,
|
|
@@ -85,6 +109,8 @@ export function dpuseBaseESLintConfig(options) {
|
|
|
85
109
|
export function dpuseESLintConfig(options) {
|
|
86
110
|
const { files = ['eslint.config.js', 'src/**/*.ts', 'tests/**/*.ts', 'vite.config.ts', 'vitest.config.ts'], ignores = [], importCoreModules = [], rules = {}, tsconfigPath = './tsconfig.json', tsconfigRootDir: tsconfigRootDirectory = process.cwd() } = options;
|
|
87
111
|
return defineConfig(
|
|
112
|
+
// ESLint's own recommended rules. Before the TypeScript configs, which switch off the ones TypeScript checks better.
|
|
113
|
+
{ ignores: NON_CODE_FILES, extends: [pluginJS.configs.recommended] },
|
|
88
114
|
// Linting scope, strict TypeScript type-checking, and module resolver.
|
|
89
115
|
{
|
|
90
116
|
files,
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,cAAc,MAAM,iDAAiD,CAAC;AAC7E,OAAO,EAAE,WAAW,IAAI,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,OAAO,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAClD,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAClD,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AA0B5D,wHAAwH;AAExH,MAAM,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,cAAc,MAAM,iDAAiD,CAAC;AAC7E,OAAO,EAAE,WAAW,IAAI,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AAChF,OAAO,QAAQ,MAAM,YAAY,CAAC;AAClC,OAAO,WAAW,MAAM,qBAAqB,CAAC;AAC9C,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,OAAO,MAAM,iBAAiB,CAAC;AACtC,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAClD,OAAO,aAAa,MAAM,uBAAuB,CAAC;AAClD,OAAO,cAAc,MAAM,wBAAwB,CAAC;AACpD,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AA0B5D,wHAAwH;AAExH,qHAAqH;AACrH,uGAAuG;AACvG,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,2CAA2C,CAAC,CAAC;AAC7E,MAAM,oBAAoB,GAAG,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;AAEpE,wHAAwH;AAExH,2HAA2H;AAC3H,MAAM,UAAU,qBAAqB,CAAC,OAAqC;IACvE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC;IAEpD,OAAO,YAAY;IACf,WAAW;IACX,aAAa,CAAC,CAAC,4BAA4B,EAAE,yBAAyB,EAAE,6BAA6B,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,CAAC;IAE7I,mHAAmH;IACnH,oHAAoH;IACpH,6DAA6D;IAC7D;QACI,OAAO,EAAE,cAAc;QACvB,OAAO,EAAE;YACL;gBACI,mGAAmG;gBACnG,OAAO,EAAE,EAAE,mCAAmC,EAAE,cAAc,EAAE;gBAChE,KAAK,EAAE;oBACH,uDAAuD,EAAE,OAAO;oBAChE,yDAAyD,EAAE,OAAO;oBAClE,wDAAwD,EAAE,OAAO;oBACjE,wDAAwD,EAAE,OAAO;oBACjE,oDAAoD,EAAE,OAAO;iBAChE;aACJ;YACD,uBAAuB,CAAC,WAAW;YACnC,sGAAsG;YACtG,yGAAyG;YACzG,cAAc;YACd,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,yBAAyB,CAAC,EAAE,OAAO,EAAE,oBAAoB,EAAE;YACpF;gBACI,OAAO,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE;gBACvB,KAAK,EAAE;oBACH,qCAAqC,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;oBAC1E,yCAAyC,EAAE,OAAO;iBACrD;aACJ;YACD,mBAAmB,CAAC,kBAAkB,CAAC;YACvC,cAAc,CAAC,OAAO,CAAC,WAAW;YAClC,aAAa,CAAC,OAAO,CAAC,WAAW;YACjC,aAAa,CAAC,OAAO,CAAC,WAAW;YACjC,cAAc;SACjB;QACD,KAAK,EAAE;YACH,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,CAAC;YAExI,uDAAuD,EAAE,MAAM;YAE/D,kCAAkC,EAAE,KAAK,EAAE,sCAAsC;YAEjF,2BAA2B,EAAE,MAAM;YACnC,uBAAuB,EAAE,MAAM;YAC/B,wBAAwB,EAAE,KAAK,EAAE,oFAAoF;YAErH,kBAAkB,EAAE,MAAM;YAE1B,uCAAuC,EAAE;gBACrC,OAAO;gBACP;oBACI,uGAAuG;oBACvG,KAAK,EAAE,CAAC,cAAc,EAAE,cAAc,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,CAAC;iBAC9I;aACJ;YACD,uBAAuB,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC;YACpF,sDAAsD,EAAE,KAAK,EAAE,mFAAmF;YAClJ,iBAAiB,EAAE,KAAK,EAAE,qCAAqC;YAC/D,yCAAyC,EAAE,KAAK,EAAE,+CAA+C;YACjG,4BAA4B,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;YAC/C,uCAAuC,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,qFAAqF;SAC/J;KACJ;IAED,qHAAqH;IACrH,0GAA0G;IAC1G;QACI,KAAK,EAAE,CAAC,SAAS,CAAC;QAClB,OAAO,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC;QAC7C,QAAQ,EAAE,cAAc;QACxB,eAAe,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE;QACxC,KAAK,EAAE;YACH,wFAAwF;YACxF,gCAAgC,EAAE,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;YACrH,8GAA8G;YAC9G,yBAAyB,EAAE,CAAC,OAAO,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;SACjE;KACJ;IAED,oGAAoG;IACpG;QACI,KAAK;QACL,KAAK,EAAE;YACH,sGAAsG;YACtG,sBAAsB;YACtB,mCAAmC,EAAE,CAAC,MAAM,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,yBAAyB,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;YAEpI,GAAG,KAAK;SACX;KACJ,CACJ,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAiC;IAC/D,MAAM,EACF,KAAK,GAAG,CAAC,kBAAkB,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,kBAAkB,CAAC,EAClG,OAAO,GAAG,EAAE,EACZ,iBAAiB,GAAG,EAAE,EACtB,KAAK,GAAG,EAAE,EACV,YAAY,GAAG,iBAAiB,EAChC,eAAe,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,EAAE,EACzD,GAAG,OAAO,CAAC;IAEZ,OAAO,YAAY;IACf,qHAAqH;IACrH,EAAE,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;IAEpE,uEAAuE;IACvE;QACI,KAAK;QACL,OAAO,EAAE,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,iBAAiB,EAAE,GAAG,QAAQ,CAAC,OAAO,CAAC,oBAAoB,CAAC;QAC1F,eAAe,EAAE;YACb,aAAa,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,qBAAqB,EAAE;SACnF;QACD,QAAQ,EAAE;YACN,uBAAuB,EAAE,iBAAiB;YAC1C,mBAAmB,EAAE;gBACjB,UAAU,EAAE,EAAE,OAAO,EAAE,CAAC,YAAY,CAAC,EAAE;aAC1C;SACJ;KACJ,EAED,GAAG,qBAAqB,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CACtD,CAAC;AACN,CAAC;AAED,eAAe,iBAAiB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dpuse/eslint-config-dpuse",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.137",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Common ESLint configuration used across DPUse projects.",
|
|
6
6
|
"license": "MIT",
|
|
@@ -56,9 +56,12 @@
|
|
|
56
56
|
},
|
|
57
57
|
"dependencies": {
|
|
58
58
|
"@eslint-community/eslint-plugin-eslint-comments": "^4.8.1",
|
|
59
|
+
"@eslint/js": "^10.0.1",
|
|
60
|
+
"@eslint/markdown": "^8.0.3",
|
|
59
61
|
"eslint-config-prettier": "^10.1.8",
|
|
60
62
|
"eslint-import-resolver-typescript": "^4.4.5",
|
|
61
63
|
"eslint-plugin-import-x": "^4.17.1",
|
|
64
|
+
"eslint-plugin-jsdoc": "^65.2.0",
|
|
62
65
|
"eslint-plugin-n": "^18.4.1",
|
|
63
66
|
"eslint-plugin-regexp": "^3.3.1",
|
|
64
67
|
"eslint-plugin-security": "^4.2.0",
|