@rpcbase/cli 0.67.0 → 0.68.0

package/bin.js

@@ -9,9 +9,12 @@ const yargs = require("yargs/yargs")
 const {hideBin} = require("yargs/helpers")
 
 const increment_pkg = require("./src/versions/increment-pkg")
+const lint = require("./src/lint")
+const lint_staged = require("./src/lint-staged")
 const print_versions = require("./src/print_versions")
-const start_command = require("./src/start_command")
 const run_agent = require("./src/run_agent")
+const start_command = require("./src/start_command")
+const stylelint = require("./src/stylelint")
 const sync_dotenv = require("./src/sync-dotenv")
 const update = require("./src/update")
 const wait_for = require("./src/wait-for")
@@ -40,6 +43,15 @@ yargs(hideBin(process.argv))
     if (argv.version) return print_versions()
     start_command(argv)
   })
+  .command(["lint"], "Run eslint", (yargs) => {}, (argv) => {
+    lint(argv)
+  })
+  .command(["stylelint"], "Run stylelint", (yargs) => {}, (argv) => {
+    stylelint(argv)
+  })
+  .command(["lint-staged"], "Run lint-staged", (yargs) => {}, (argv) => {
+    lint_staged(argv)
+  })
   .command(["agent"], "Run the agent", (yargs) => {
     // yargs
       // .option("option1", {

package/eslint/config.js

@@ -0,0 +1,92 @@
+/* @flow */
+const mobile_overrides = require("./src/mobile_overrides")
+
+
+module.exports = {
+  parser: "@babel/eslint-parser",
+  parserOptions: {
+    requireConfigFile: false,
+  },
+  // workingDirectories:{mode: "auto"},
+  ignorePatterns: [
+    "**/*.{css,scss}",
+    "*.eslintrc.js",
+    "**/node_modules/**",
+    "**/.nyc_output/**",
+    "**/coverage/**",
+    "**/build/**",
+    "client/static/**",
+  ],
+  env: {
+    browser: true,
+    es6: true,
+    node: true,
+    jest: true,
+  },
+  settings: {
+    react: {
+      version: "18"
+    }
+  },
+  plugins: ["react", "react-hooks", "flowtype", "import", "lodash"],
+  extends: [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:react/jsx-runtime",
+    "plugin:flowtype/recommended",
+  ],
+  globals: {
+    cx: "readonly",
+    monaco: "readonly",
+    // tests
+    page: "readonly",
+    browser: "readonly",
+    context: "readonly",
+    __DEV__: "readonly",
+    __DETOX__: "readonly",
+  },
+  rules: {
+    // "@rpcbase/lint/no-unused-imports": "warn",
+    "@rpcbase/lint/no-rb-restricted-imports": ["error", [
+      {"name": "mongodb", "message": "do not import the 'mongodb' module, this can cause issues, use mongoose.mongo"},
+      {"name": "mongoose", "message": "use @rpcbase/server/mongoose"},
+    ]],
+    "array-callback-return": "error",
+    "comma-dangle": ["error", "always-multiline"],
+    "import/newline-after-import": ["error", {"count": 2}],
+    "import/extensions": ["error", "never", {"svg": "always", "scss": "always", "css": "always", "json": "always"}],
+    "import/no-relative-parent-imports": ["warn"],
+    "lodash/import-scope": ["error", "method"],
+    "max-len": "off",
+    "no-async-promise-executor": "warn",
+    "no-case-declarations": "warn",
+    "no-console": ["warn", {allow: ["warn", "error"]}],
+    "no-constant-condition": ["warn", {"checkLoops": false}],
+    "no-empty": ["error", { "allowEmptyCatch": true }],
+    "no-irregular-whitespace": ["error", {skipRegExps: false, skipStrings: false, skipComments: false}],
+    "no-misleading-character-class": ["error"],
+    "no-return-await": "error",
+    "no-shadow": ["error", {"allow": ["err", "error"]}],
+    "no-redeclare": ["error", {"builtinGlobals": true}],
+    "no-undefined": "warn",
+    "no-useless-escape": "warn",
+    "no-use-before-define": ["error", {variables: true, functions: true, classes: true}],
+    "no-var": "error",
+    "flowtype/boolean-style": ["error", "boolean"],
+    "prefer-template": ["error"],
+    "quotes": ["error", "double", {"allowTemplateLiterals": true}],
+    "react-hooks/exhaustive-deps": "warn",
+    "react-hooks/rules-of-hooks": "error",
+    "react/display-name": "warn",
+    "react/no-access-state-in-setstate": "error",
+    "react/no-find-dom-node": "warn",
+    "react/no-unescaped-entities": "warn",
+    "react/no-unknown-property": "warn",
+    "react/react-in-jsx-scope": "off",
+    "spaced-comment": ["error", "always"],
+    "space-before-function-paren": ["error", "never"],
+  },
+  overrides: [
+    mobile_overrides,
+  ]
+}

package/eslint/index.js

@@ -0,0 +1,8 @@
+/* @flow */
+
+module.exports = {
+  rules: {
+    "no-unused-imports": require("./src/rules/no-unused-imports"),
+    "no-rb-restricted-imports": require("./src/rules/no-rb-restricted-imports")
+  }
+}

package/eslint/src/mobile_overrides.js

@@ -0,0 +1,10 @@
+/* @flow */
+
+module.exports = {
+  files: [ "mobile/spec/**" ],
+  globals: {
+    device: "readonly",
+    element: "readonly",
+    by: "readonly",
+  },
+}

package/eslint/src/rules/no-rb-restricted-imports/index.js

@@ -0,0 +1,31 @@
+/* @flow */
+
+module.exports = {
+  create(context) {
+    const restrictedImports = context.options[0] || []
+
+    function checkNode(node, moduleName) {
+      const restrictedImport = restrictedImports.find(r => r.name === moduleName)
+      if (restrictedImport) {
+        context.report({
+          node,
+          message: restrictedImport.message,
+          data: {
+            name: moduleName,
+          },
+        })
+      }
+    }
+
+    return {
+      "ImportDeclaration"(node) {
+        checkNode(node, node.source.value)
+      },
+      "CallExpression"(node) {
+        if (node.callee.name === "require" && node.arguments[0] && node.arguments[0].type === "Literal") {
+          checkNode(node, node.arguments[0].value)
+        }
+      },
+    }
+  },
+}

package/eslint/src/rules/no-unused-imports/index.js

@@ -0,0 +1,67 @@
+/* @flow */
+
+const noUnusedImports = {
+  meta: {
+    fixable: "code",
+  },
+  create(context) {
+    const getRemovalRange = (importSpecifier, sourceCode) => {
+
+      const tokenBefore = sourceCode.getTokenBefore(importSpecifier)
+      const tokenAfter = sourceCode.getTokenAfter(importSpecifier)
+
+      // if there is a comma before the punctuator, remove the comma as well
+      if (tokenBefore.value === "{") {
+        const tokenBeforeBefore = sourceCode.getTokenBefore(tokenBefore)
+        if (tokenBeforeBefore.value === ",") {
+          return [
+            sourceCode.getTokenBefore(tokenBeforeBefore).range[1],
+            tokenAfter.range[1],
+          ]
+        }
+      }
+
+      if (tokenBefore.value === ",") {
+        return [tokenBefore.range[0], importSpecifier.range[1]]
+      } else if (tokenAfter.value === ",") {
+        return [importSpecifier.range[0] - 1, tokenAfter.range[1]] // Include the space before the specifier
+      }
+
+      // When there is no comma, remove the whole specifier including surrounding spaces
+      return [
+        sourceCode.getTokenBefore(tokenBefore).range[1],
+        sourceCode.getTokenAfter(tokenAfter).range[0],
+      ]
+    }
+
+    return {
+      "ImportDeclaration"(node) {
+        const sourceCode = context.getSourceCode()
+        const importSpecifiers = node.specifiers
+
+        importSpecifiers.forEach((importSpecifier) => {
+          const localName = importSpecifier.local.name
+
+          const variable = context.getScope().variables.find((v) => v.name === localName)
+
+          if (variable && variable.references.length === 0) {
+            context.report({
+              node: importSpecifier,
+              message: `'${localName}' is defined but never used.`,
+              fix(fixer) {
+                if (importSpecifiers.length === 1) {
+                  return fixer.remove(node)
+                } else {
+                  const removalRange = getRemovalRange(importSpecifier, sourceCode)
+                  return fixer.removeRange(removalRange)
+                }
+              },
+            })
+          }
+        })
+      },
+    }
+  },
+}
+
+module.exports = noUnusedImports

package/eslint/src/rules/no-unused-imports/test.js

@@ -0,0 +1,54 @@
+/* @flow */
+const { RuleTester } = require("eslint")
+
+const noUnusedImports = require("./index")
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    ecmaVersion: 2021,
+    sourceType: "module",
+  },
+});
+
+
+ruleTester.run('no-unused-imports', noUnusedImports, {
+  valid: [
+    "import used from './module'; used();",
+    "import * as used from './module'; used.foo();",
+    "import { used } from './module'; used();",
+    "import { used as alias } from './module'; alias();",
+  ],
+
+  invalid: [
+    {
+      code: "import unused from './module';",
+      errors: [{ message: "'unused' is defined but never used." }],
+      output: '',
+    },
+    {
+      code: "import * as unused from './module';",
+      errors: [{ message: "'unused' is defined but never used." }],
+      output: '',
+    },
+    {
+      code: "import { unused } from './module';",
+      errors: [{ message: "'unused' is defined but never used." }],
+      output: '',
+    },
+    {
+      code: "import { unused as alias } from './module';",
+      errors: [{ message: "'alias' is defined but never used." }],
+      output: '',
+    },
+    {
+      code: "import used, { unused } from './module'; used();",
+      errors: [{ message: "'unused' is defined but never used." }],
+      output: "import used from './module'; used();",
+    },
+    {
+      code: "import { used, unused } from './module'; used();",
+      errors: [{ message: "'unused' is defined but never used." }],
+      output: "import { used } from './module'; used();",
+    },
+  ],
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/cli",
-  "version": "0.67.0",
+  "version": "0.68.0",
   "license": "SSPL-1.0",
   "bin": {
     "rb": "./bin.js"
@@ -10,6 +10,8 @@
   },
   "files": [
     "src/",
+    "eslint/",
+    "stylelint/",
     "!src/**/*.test.js"
   ],
   "scripts": {
@@ -38,16 +40,30 @@
     }
   },
   "dependencies": {
+    "@babel/core": "7.24.9",
+    "@babel/eslint-parser": "7.25.0",
+    "@babel/plugin-syntax-flow": "7.24.7",
+    "@babel/plugin-transform-react-jsx": "7.24.7",
     "@rpcbase/agent": "0.42.0",
     "bluebird": "3.7.2",
     "concurrently": "8.2.2",
-    "debug": "4.3.4",
+    "debug": "4.3.6",
     "dotenv": "16.4.5",
+    "eslint": "8.57.0",
+    "eslint-plugin-flowtype": "8.0.3",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-lodash": "8.0.0",
+    "eslint-plugin-react": "7.35.0",
+    "eslint-plugin-react-hooks": "4.6.2",
+    "lint-staged": "15.2.7",
     "octokit": "3.1.2",
     "parse-dotenv": "2.1.0",
-    "picocolors": "1.0.0",
+    "picocolors": "1.0.1",
     "semver": "7.6.0",
-    "validator": "13.11.0",
+    "stylelint": "16.7.0",
+    "stylelint-config-standard": "36.0.0",
+    "stylelint-config-standard-scss": "13.1.0",
+    "validator": "13.12.0",
     "yargs": "17.7.2"
   },
   "devDependencies": {

package/src/lint-staged.js

@@ -0,0 +1,17 @@
+const path = require("path")
+const {spawn} = require("child_process")
+
+const {hideBin} = require("yargs/helpers")
+
+module.exports = () => {
+  const args = hideBin(process.argv).slice(1) // remove first arg
+
+  const package_dir = path.dirname(require.resolve("lint-staged/package.json"))
+  const bin_path = path.join(package_dir, "./bin/lint-staged.js")
+
+  const ps = spawn(bin_path, args, { stdio: "inherit" })
+
+  ps.on("close", (code) => {
+    process.exit(code)
+  })
+}

package/src/lint.js

@@ -0,0 +1,17 @@
+const path = require("path")
+const {spawn} = require("child_process")
+
+const {hideBin} = require("yargs/helpers")
+
+module.exports = () => {
+  const args = hideBin(process.argv).slice(1) //remove first arg (our rb command 'lint')
+
+  const eslint_path = path.dirname(require.resolve("eslint/package.json"))
+  const bin_path = path.join(eslint_path, "./bin/eslint.js")
+
+  const ps = spawn(bin_path, args, { stdio: "inherit" })
+
+  ps.on("close", (code) => {
+    process.exit(code)
+  })
+}

package/src/stylelint.js

@@ -0,0 +1,25 @@
+const path = require("path")
+const fs = require("fs")
+const {spawn} = require("child_process")
+
+const {hideBin} = require("yargs/helpers")
+
+module.exports = () => {
+  const args = hideBin(process.argv).slice(1) //remove first arg
+
+  const config_path = path.join(process.cwd(), "./.stylelintrc.js")
+  const has_config = fs.existsSync(config_path)
+
+  if (!has_config) {
+    throw new Error("cannot find .stylelintrc.js config file")
+  }
+
+  const stylelint_path = path.dirname(require.resolve("stylelint/package.json"))
+  const bin_path = path.join(stylelint_path, "./bin/stylelint.mjs")
+
+  const ps = spawn(bin_path, ["--config", config_path, ...args], { stdio: "inherit" })
+
+  ps.on("close", (code) => {
+    process.exit(code)
+  })
+}

package/stylelint/index.js

@@ -0,0 +1,15 @@
+module.exports = {
+  "extends": [
+    "stylelint-config-standard-scss"
+  ],
+  "rules": {
+    "color-named": ["never", {severity: "warning"}],
+    "color-no-hex": [true, {severity: "warning"}],
+    "declaration-block-no-redundant-longhand-properties": null,
+    "declaration-empty-line-before": null,
+    "no-descending-specificity": [true, {severity: "warning"}],
+    "scss/comment-no-empty": null,
+    "scss/no-global-function-names": [true, {severity: "warning"}],
+    "selector-class-pattern": null,
+  }
+}