@mrpalmer/eslint-plugin 1.0.2 → 1.1.0

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 import type { TSESLint } from '@typescript-eslint/utils';
+type PluginRules = Record<string, TSESLint.RuleModule<string, readonly unknown[]>>;
 declare const _default: {
     configs: {
         recommended: {
@@ -9,11 +10,7 @@ declare const _default: {
                         name: string;
                         version: string;
                     };
-                    rules: {
-                        'shorten-paths': TSESLint.RuleModule<"shortenImport" | "shortenExport", import("./rules/shorten-paths.js").Options, unknown, TSESLint.RuleListener>;
-                        'sort-imports': TSESLint.RuleModule<"error" | "order" | "noLineBetweenImports", [import("./rules/sort-imports.js").Options], unknown, TSESLint.RuleListener>;
-                        'sort-named': TSESLint.RuleModule<"order", [import("./rules/sort-named.js").Options], unknown, TSESLint.RuleListener>;
-                    };
+                    rules: PluginRules;
                 };
             };
             rules: {
@@ -22,15 +19,12 @@ declare const _default: {
                 'mrpalmer/sort-named': "warn";
             };
         };
+        json: TSESLint.FlatConfig.Config;
     };
     meta: {
         name: string;
         version: string;
     };
-    rules: {
-        'shorten-paths': TSESLint.RuleModule<"shortenImport" | "shortenExport", import("./rules/shorten-paths.js").Options, unknown, TSESLint.RuleListener>;
-        'sort-imports': TSESLint.RuleModule<"error" | "order" | "noLineBetweenImports", [import("./rules/sort-imports.js").Options], unknown, TSESLint.RuleListener>;
-        'sort-named': TSESLint.RuleModule<"order", [import("./rules/sort-named.js").Options], unknown, TSESLint.RuleListener>;
-    };
+    rules: PluginRules;
 };
 export default _default;

package/lib/index.js

@@ -1,9 +1,13 @@
+import jsonPlugin from '@eslint/json';
 import { meta } from './meta.js';
 // rules
+import requirePackageScope from './rules/require-package-scope.js';
 import shortenPathsRule from './rules/shorten-paths.js';
 import sortImportsRule from './rules/sort-imports.js';
 import sortNamedRule from './rules/sort-named.js';
 const rules = {
+    // @ts-expect-error -- require-package-scope is a JSON rule
+    'require-package-scope': requirePackageScope,
     'shorten-paths': shortenPathsRule,
     'sort-imports': sortImportsRule,
     'sort-named': sortNamedRule,
@@ -23,9 +27,18 @@ const recommended = {
         'mrpalmer/sort-named': 'warn',
     },
 };
+const json = {
+    name: 'mrpalmer/json',
+    plugins: {
+        json: jsonPlugin,
+        mrpalmer: plugin,
+    },
+    language: 'json/json',
+};
 export default {
     ...plugin,
     configs: {
         recommended,
+        json,
     },
 };

package/lib/rules/require-package-scope.d.ts

@@ -0,0 +1,11 @@
+import type { JSONRuleDefinition } from '@eslint/json/types';
+export type MessageIds = 'requirePackageScope' | 'forbidPackageScope';
+export type RuleOptions = [{
+    scope: string | false;
+}];
+export type RequirePackageScopeRuleDefinition = JSONRuleDefinition<{
+    RuleOptions: RuleOptions;
+    MessageIds: MessageIds;
+}>;
+declare const rule: RequirePackageScopeRuleDefinition;
+export default rule;

package/lib/rules/require-package-scope.js

@@ -0,0 +1,54 @@
+const rule = {
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Require or forbid package scopes in package names.',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    scope: {
+                        anyOf: [{ type: 'string' }, { type: 'boolean', enum: [false] }],
+                        description: 'The required scope for package names, or false to forbid scopes.',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        defaultOptions: [{ scope: false }],
+        messages: {
+            requirePackageScope: 'Packages must use the "@{{scope}}" scope.',
+            forbidPackageScope: 'Packages must not use a scope.',
+        },
+    },
+    create(context) {
+        const [{ scope }] = context.options;
+        return {
+            Document(node) {
+                if (node.body.type !== 'Object') {
+                    return;
+                }
+                const nameProperty = node.body.members.find((member) => member.name.type === 'String' && member.name.value === 'name');
+                if (nameProperty?.value.type !== 'String') {
+                    return;
+                }
+                const packageName = nameProperty.value.value;
+                if (scope === false && packageName.startsWith('@')) {
+                    context.report({
+                        node: nameProperty.value,
+                        messageId: 'forbidPackageScope',
+                    });
+                }
+                else if (scope && !packageName.startsWith(`@${scope}/`)) {
+                    context.report({
+                        node: nameProperty.value,
+                        messageId: 'requirePackageScope',
+                        data: { scope },
+                    });
+                }
+            },
+        };
+    },
+};
+export default rule;

package/lib/rules/sort-imports.d.ts

@@ -11,8 +11,8 @@ interface PathGroup {
     isSideEffect?: boolean;
 }
 export interface Options {
-    groups: ReadonlyArray<Arrayable<ImportType>>;
-    pathGroups: PathGroup[];
+    groups?: ReadonlyArray<Arrayable<ImportType>>;
+    pathGroups?: PathGroup[];
 }
 type MessageId = 'error' | 'order' | 'noLineBetweenImports';
 declare const _default: TSESLint.RuleModule<MessageId, [Options], unknown, TSESLint.RuleListener>;

package/lib/rules/sort-imports.js

@@ -536,12 +536,12 @@ export default createRule({
         const tsConfigPaths = loadConfig(settings)?.config.compilerOptions?.paths ?? {};
         let ranks;
         try {
-            const { pathGroups, maxPosition } = convertPathGroupsForRanks(options.pathGroups, Object.keys(tsConfigPaths));
+            const { pathGroups, maxPosition } = convertPathGroupsForRanks(options.pathGroups ?? [], Object.keys(tsConfigPaths));
             const types = new Set(baseTypes);
             pathGroups.forEach((group) => {
                 types.add(group.group);
             });
-            const { groups, omittedTypes } = convertGroupsToRanks(['sideEffect', ...options.groups], types, settings['mrpalmer/coreModules']);
+            const { groups, omittedTypes } = convertGroupsToRanks(['sideEffect', ...(options.groups ?? defaultGroups)], types, settings['mrpalmer/coreModules']);
             ranks = {
                 groups,
                 omittedTypes,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrpalmer/eslint-plugin",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Custom ESLint rules for Mike Palmer's projects",
   "license": "MIT",
   "type": "module",
@@ -11,7 +11,7 @@
     },
     "./package.json": "./package.json"
   },
-  "main": "./lib/index.js",
+  "module": "./lib/index.js",
   "files": [
     "lib"
   ],
@@ -21,6 +21,7 @@
     "minimatch": "^10.0.1"
   },
   "peerDependencies": {
+    "@eslint/json": "^0.14.0",
     "@typescript-eslint/utils": "^8.0.0",
     "eslint": "^9.0.0"
   },