eslint-plugin-digigov 1.0.0 → 2.0.0-aefd0709

package/.rush/temp/shrinkwrap-deps.json

@@ -1,26 +1,5 @@
 {
-  "balanced-match@1.0.2": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==",
-  "brace-expansion@2.0.1": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
-  "find-up@3.0.0": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==",
-  "fs.realpath@1.0.0": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==",
-  "glob@8.1.0": "sha512-r8hpEjiQEYlF2QU0df3dS+nxxSIreXQS1qRhMJM0Q5NDdR386C7jb7Hwwod8Fgiuex+k0GFjgft18yvxm5XoCQ==",
-  "ignore-walk@5.0.1": "sha512-yemi4pMf51WKT7khInJqAvsIGzoqYXblnsz0ql8tM+yi1EKYTY1evX4NAbJrLL/Aanr2HyZeluqU+Oi7MGHokw==",
-  "inflight@1.0.6": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==",
-  "inherits@2.0.4": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==",
-  "locate-path@3.0.0": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==",
-  "minimatch@5.1.6": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==",
-  "mri@1.2.0": "sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==",
-  "npm-bundled@2.0.1": "sha512-gZLxXdjEzE/+mOstGDqR6b0EkhJ+kM6fxM6vUuckuctuVPh80Q6pw/rSZj9s4Gex9GxWtIicO1pc8DB9KZWudw==",
-  "npm-normalize-package-bin@2.0.0": "sha512-awzfKUO7v0FscrSpRoogyNm0sajikhBWpU0QMrW09AMi9n1PoKU6WaIqUzuJSQnpciZZmJ/jMZ2Egfmb/9LiWQ==",
-  "npm-packlist@5.1.3": "sha512-263/0NGrn32YFYi4J533qzrQ/krmmrWwhKkzwTuM4f/07ug51odoaNjUexxO4vxlzURHcmYMH1QjvHjsNDKLVg==",
-  "once@1.4.0": "sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==",
-  "p-limit@2.3.0": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==",
-  "p-locate@3.0.0": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==",
-  "p-try@2.2.0": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==",
-  "path-exists@3.0.0": "sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==",
-  "picocolors@1.0.0": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==",
-  "pkg-up@3.1.0": "sha512-nDywThFk1i4BQK4twPQ6TA4RT8bDY96yeuCVBWL3ePARCiEKDRSrNGbFIgUJpLp+XeIR65v8ra7WuJOFUBtkMA==",
-  "publint@0.1.8": "sha512-czOfocZAwS3d5RNrx4VyMxJJDyTn9MajMfuzJYlMrztFLrWkM+3KVdPozTfd8ka8aGWfR1cS66tMSDCgF70T+A==",
-  "sade@1.8.1": "sha512-xal3CZX1Xlo/k4ApwCFrHVACi9fBqJ7V+mwhBsuf/1IOKbBy098Fex+Wa/5QMubw09pSZ/u8EY8PWgevJsXp1A==",
-  "wrappy@1.0.2": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ=="
+  "../../plugins/eslint-plugin-digigov": "../../plugins/eslint-plugin-digigov:FuTkehhmJHluucbHj/hmgVsDXe1jqeerjTvx5/1AawY=:",
+  "/eslint@9.16.0(jiti@1.21.6)": "Missing shrinkwrap entry!",
+  "/publint@0.1.8": "Missing shrinkwrap entry!"
 }

package/index.js

@@ -1,7 +1,21 @@
-exports.rules = {
-  'no-relative-imports': require('./rules/no-relative-imports'),
-};
+import noRelativeImports from "./rules/no-relative-imports/index.js";
 
-exports.configs = {
-  recommended: require('./config/recommended'),
+const plugin = {
+  configs: {},
+  rules: {
+    "no-relative-imports": noRelativeImports,
+  },
 };
+
+Object.assign(plugin.configs, {
+  recommended: {
+    plugins: {
+      digigov: plugin,
+    },
+    rules: {
+      "digigov/no-relative-imports": "warn",
+    },
+  },
+});
+
+export default plugin;

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "eslint-plugin-digigov",
-  "version": "1.0.0",
+  "version": "2.0.0-aefd0709",
   "description": "Custom lint rules for digigov projects",
   "main": "index.js",
+  "type": "module",
   "author": "GRNET Devs <devs@lists.grnet.gr>",
   "license": "BSD-2-Clause",
   "dependencies": {
-    "pkg-up": "3.1.0",
-    "publint": "0.1.8"
+    "@digigov/cli": "2.0.0-aefd0709"
   },
   "devDependencies": {
     "publint": "0.1.8"
   },
+  "peerDependencies": {
+    "eslint": "^9"
+  },
   "scripts": {
     "publint": "publint"
   }
-}
+}

package/rules/no-relative-imports/index.js

@@ -1,36 +1,33 @@
-const moduleVisitor = require('./moduleVisitor');
-const path = require('path');
-const pkgUp = require('pkg-up');
-const pkgLocation = pkgUp.sync()
-const package = require(pkgLocation)
-const project = {
-  name: package.name,
-  root: path.dirname(pkgLocation)
-}
+import moduleVisitor from "./moduleVisitor.js";
+import path from "path";
+import { resolveProject } from "@digigov/cli/lib";
+
+const project = resolveProject();
+
 const rule = {
   meta: {
-    type: 'suggestion',
+    type: "suggestion",
     docs: {
-      url: '',
+      description: "Disallow relative imports",
     },
-    fixable: true,
+    fixable: "code",
     schema: [
       {
-        type: 'object',
+        type: "object",
         properties: {
-          commonjs: { type: 'boolean' },
-          amd: { type: 'boolean' },
-          esmodule: { type: 'boolean' },
+          commonjs: { type: "boolean" },
+          amd: { type: "boolean" },
+          esmodule: { type: "boolean" },
           ignore: {
-            type: 'array',
+            type: "array",
             minItems: 1,
-            items: { type: 'string' },
+            items: { type: "string" },
             uniqueItems: true,
           },
           root: {
-            type: 'string',
-            enum: ['package-name', 'src']
-          }
+            type: "string",
+            enum: ["package-name", "src"],
+          },
         },
         additionalProperties: false,
       },
@@ -39,37 +36,34 @@ const rule = {
 
   create: function noRelativePackages(context) {
     const myPath = context.getFilename();
-    let root = 'package-name'
-    if(context.options.length){
-      if(context.options[0].root){
-        root = context.options[0].root
+    let root = "package-name";
+    if (context.options.length) {
+      if (context.options[0].root) {
+        root = context.options[0].root;
       }
     }
-    if (myPath === '<text>') return {}; // can't check a non-file
+    if (myPath === "<text>") return {}; // can't check a non-file
 
     function checkSourceValue(sourceNode) {
       if (sourceNode.value.match(/^\./)) {
         const absoluteImportPath = path.resolve(
           path.dirname(myPath),
-          sourceNode.value
+          sourceNode.value,
         );
-        if(absoluteImportPath.endsWith('.svg')){
-          return
+        if (absoluteImportPath.endsWith(".svg")) {
+          return;
         }
         // TODO: fix issue with importing svg files with babel-module-resolver
         // lint only import strings that dont have an svg extension
-        if (path.extname(absoluteImportPath) !== '.svg') {
-          const newPath = `'${root === 'package-name' ?project.name + '/':''}${absoluteImportPath
-            .replace(
-              `${project.root}/src/`,
-              ''
-            )
-            .replace(/index$/, '')}'`;
+        if (path.extname(absoluteImportPath) !== ".svg") {
+          const newPath = `'${root === "package-name" ? project.name + "/" : ""}${absoluteImportPath
+            .replace(`${project.root}/src/`, "")
+            .replace(/index$/, "")}'`;
           context.report({
             node: sourceNode,
             message:
-              'Please use the absolute path of a file using the package name of your application as stated in the `name` key in your `package.json` file.\n' +
-              'Use of relative imports is not recommended\n' +
+              "Please use the absolute path of a file using the package name of your application as stated in the `name` key in your `package.json` file.\n" +
+              "Use of relative imports is not recommended\n" +
               `For this instance use ${newPath} instead of ${sourceNode.value}`,
             fix: (fixer) => {
               // see https://eslint.org/docs/developer-guide/working-with-rules#applying-fixes
@@ -84,4 +78,4 @@ const rule = {
   },
 };
 
-module.exports = rule;
+export default rule;

package/rules/no-relative-imports/moduleVisitor.js

@@ -7,7 +7,7 @@
  * @param  {[type]} options [description]
  * @return {object}
  */
-module.exports = function visitModules(visitor, options) {
+export default function visitModules(visitor, options) {
   // if esmodule is not explicitly disabled, it is assumed to be enabled
   options = Object.assign({ esmodule: true }, options);
 
@@ -33,12 +33,12 @@ module.exports = function visitModules(visitor, options) {
 
   // for esmodule dynamic `import()` calls
   function checkImportCall(node) {
-    if (node.callee.type !== 'Import') return;
+    if (node.callee.type !== "Import") return;
     if (node.arguments.length !== 1) return;
 
     const modulePath = node.arguments[0];
-    if (modulePath.type !== 'Literal') return;
-    if (typeof modulePath.value !== 'string') return;
+    if (modulePath.type !== "Literal") return;
+    if (typeof modulePath.value !== "string") return;
 
     checkSourceValue(modulePath, node);
   }
@@ -46,30 +46,30 @@ module.exports = function visitModules(visitor, options) {
   // for CommonJS `require` calls
   // adapted from @mctep: http://git.io/v4rAu
   function checkCommon(call) {
-    if (call.callee.type !== 'Identifier') return;
-    if (call.callee.name !== 'require') return;
+    if (call.callee.type !== "Identifier") return;
+    if (call.callee.name !== "require") return;
     if (call.arguments.length !== 1) return;
 
     const modulePath = call.arguments[0];
-    if (modulePath.type !== 'Literal') return;
-    if (typeof modulePath.value !== 'string') return;
+    if (modulePath.type !== "Literal") return;
+    if (typeof modulePath.value !== "string") return;
 
     checkSourceValue(modulePath, call);
   }
 
   function checkAMD(call) {
-    if (call.callee.type !== 'Identifier') return;
-    if (call.callee.name !== 'require' && call.callee.name !== 'define') return;
+    if (call.callee.type !== "Identifier") return;
+    if (call.callee.name !== "require" && call.callee.name !== "define") return;
     if (call.arguments.length !== 2) return;
 
     const modules = call.arguments[0];
-    if (modules.type !== 'ArrayExpression') return;
+    if (modules.type !== "ArrayExpression") return;
 
     for (const element of modules.elements) {
-      if (element.type !== 'Literal') continue;
-      if (typeof element.value !== 'string') continue;
+      if (element.type !== "Literal") continue;
+      if (typeof element.value !== "string") continue;
 
-      if (element.value === 'require' || element.value === 'exports') continue; // magic modules: http://git.io/vByan
+      if (element.value === "require" || element.value === "exports") continue; // magic modules: http://git.io/vByan
 
       checkSourceValue(element, element);
     }
@@ -95,4 +95,4 @@ module.exports = function visitModules(visitor, options) {
   }
 
   return visitors;
-};
+}

package/config/recommended.js

@@ -1,21 +0,0 @@
-/**
- * The basics.
- * @type {Object}
- */
-module.exports = {
-  plugins: ['digigov'],
-
-  rules: {
-    // analysis/correctness
-    // 'digigov/no-relative-imports': 'error',
-    // red flags (thus, warnings)
-    'digigov/no-relative-imports': 'warn',
-  },
-
-  // need all these for parsing dependencies (even if _your_ code doesn't need
-  // all of them)
-  parserOptions: {
-    sourceType: 'module',
-    ecmaVersion: 2018,
-  },
-};