@storm-software/linting-tools 1.43.0 → 1.44.1

package/.eslintrc.json

@@ -0,0 +1,97 @@
+{
+  "extends": ["../../.eslintrc.json", "../../.eslintrc.base.json"],
+  "ignorePatterns": ["!**/*", "node_modules/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": [
+          "error",
+          {
+            "buildTargets": ["build"],
+            "ignoredFiles": [
+              "{projectRoot}/esbuild.config.{js,ts,mjs,mts}",
+              "{projectRoot}/jest.config.ts"
+            ],
+            "ignoredDependencies": [
+              "@cspell/dict-ada",
+              "@cspell/dict-aws",
+              "@cspell/dict-bash",
+              "@cspell/dict-companies",
+              "@cspell/dict-cpp",
+              "@cspell/dict-cryptocurrencies",
+              "@cspell/dict-csharp",
+              "@cspell/dict-css",
+              "@cspell/dict-dart",
+              "@cspell/dict-django",
+              "@cspell/dict-docker",
+              "@cspell/dict-dotnet",
+              "@cspell/dict-elixir",
+              "@cspell/dict-en_us",
+              "@cspell/dict-en-common-misspellings",
+              "@cspell/dict-en-gb",
+              "@cspell/dict-filetypes",
+              "@cspell/dict-fonts",
+              "@cspell/dict-fsharp",
+              "@cspell/dict-fullstack",
+              "@cspell/dict-gaming-terms",
+              "@cspell/dict-git",
+              "@cspell/dict-golang",
+              "@cspell/dict-haskell",
+              "@cspell/dict-html-symbol-entities",
+              "@cspell/dict-html",
+              "@cspell/dict-java",
+              "@cspell/dict-k8s",
+              "@cspell/dict-latex",
+              "@cspell/dict-lorem-ipsum",
+              "@cspell/dict-lua",
+              "@cspell/dict-makefile",
+              "@cspell/dict-node",
+              "@cspell/dict-npm",
+              "@cspell/dict-php",
+              "@cspell/dict-powershell",
+              "@cspell/dict-public-licenses",
+              "@cspell/dict-python",
+              "@cspell/dict-r",
+              "@cspell/dict-ruby",
+              "@cspell/dict-rust",
+              "@cspell/dict-scala",
+              "@cspell/dict-sql",
+              "@cspell/dict-software-terms",
+              "@cspell/dict-svelte",
+              "@cspell/dict-swift",
+              "@cspell/dict-typescript",
+              "@cspell/dict-vue",
+              "@size-limit/file",
+              "@size-limit/time",
+              "size-limit",
+              "remark-retext",
+              "remark-parse",
+              "remark-mdx",
+              "remark-gfm",
+              "remark-frontmatter",
+              "rehype-retext",
+              "rehype-parse"
+            ],
+            "checkMissingDependencies": true,
+            "checkObsoleteDependencies": true,
+            "checkVersionMismatches": false
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -1,3 +1,46 @@
+## 1.44.1 (2024-03-25)
+
+
+### 🩹 Fixes
+
+- **storm-workspace:** Resolved issue with failed unit-test ([42e5a411](https://github.com/storm-software/storm-ops/commit/42e5a411))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
+## 1.44.0 (2024-03-25)
+
+
+### 🚀 Features
+
+- **workspace-tools:** Added Nx plugin to apply rust and typescript targets ([5738161f](https://github.com/storm-software/storm-ops/commit/5738161f))
+
+- **workspace-tools:** Major updates to base nx.json configuration ([06ec9a6a](https://github.com/storm-software/storm-ops/commit/06ec9a6a))
+
+
+### 🩹 Fixes
+
+- **git-tools:** Resolved issues with `left-hook` scripts ([daf28aa2](https://github.com/storm-software/storm-ops/commit/daf28aa2))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
+## 1.43.1 (2024-03-19)
+
+
+### 🩹 Fixes
+
+- **linting-tools:** Update the linting-tools asset configuration ([c35e2491](https://github.com/storm-software/storm-ops/commit/c35e2491))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan
+
 ## 1.43.0 (2024-03-19)
 
 

package/README.md

@@ -16,7 +16,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-1.42.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Version](https://img.shields.io/badge/version-1.43.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
 [![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 > [!IMPORTANT]

package/bin/lint.ts

@@ -1,25 +1,36 @@
-#!/usr/bin/env node
-
 import {
   exitWithSuccess,
   handleProcess,
   loadStormConfig,
-  writeSuccess
+  writeSuccess,
+  writeFatal,
+  exitWithError
 } from "@storm-software/config-tools";
 import { createProgram } from "../src/cli";
+import { register as registerTsConfigPaths } from "tsconfig-paths";
+import { join } from "node:path";
+import { readJsonSync } from "fs-extra";
 
-const handle = async () => {
+void (async () => {
   const config = await loadStormConfig();
-  handleProcess(config);
+  try {
+    handleProcess(config);
 
-  const program = await createProgram(config);
-  program.exitOverride();
+    const compilerOptions = readJsonSync(
+      join(config.workspaceRoot ?? "./", "tsconfig.base.json")
+    ).compilerOptions;
+    registerTsConfigPaths(compilerOptions);
 
-  await program.parseAsync(process.argv);
+    const program = await createProgram(config);
+    program.exitOverride();
 
-  writeSuccess(config, "Code linting and fixing completed successfully!");
-};
+    await program.parseAsync(process.argv);
 
-handle().then(() => {
-  loadStormConfig().then((config) => exitWithSuccess(config));
-});
+    writeSuccess(config, "Code linting and fixing completed successfully!");
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(config, `A fatal error occurred while running the program: ${error.message}`);
+    exitWithError(config);
+    process.exit(1);
+  }
+})();

package/jest.config.ts

@@ -0,0 +1,11 @@
+/* eslint-disable */
+export default {
+  displayName: "linting-tools",
+  preset: "../../jest.preset.js",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }]
+  },
+  moduleFileExtensions: ["ts", "js", "html"],
+  coverageDirectory: "../../coverage/packages/linting-tools"
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/linting-tools",
-  "version": "1.43.0",
+  "version": "1.44.1",
   "private": false,
   "description": "⚡ A package containing various linting tools used to validate syntax, enforce design standards, and format code in a Storm workspace.",
   "keywords": [
@@ -22,7 +22,7 @@
     "url": "https://github.com/storm-software/storm-ops",
     "directory": "packages/linting-tools"
   },
-  "license": "Apache License 2.0",
+  "license": "Apache 2.0",
   "author": {
     "name": "Storm Software",
     "email": "contact@stormsoftware.org",
@@ -87,13 +87,12 @@
     "@size-limit/time": "11.0.2",
     "alex": "11.0.1",
     "check-dependency-version-consistency": "4.1.0",
-    "child_process": "1.0.2",
     "commander": "11.1.0",
     "cspell": "8.3.2",
     "dpdm": "3.14.0",
     "eslint": "8.56.0",
+    "fs-extra": "11.2.0",
     "p-limit": "4.0.0",
-    "prettier-plugin-tailwindcss": "0.5.11",
     "rehype-parse": "9.0.0",
     "rehype-retext": "4.0.0",
     "remark-frontmatter": "5.0.0",
@@ -106,16 +105,21 @@
     "retext-profanities": "8.0.0",
     "size-limit": "11.0.2",
     "spawndamnit": "2.0.0",
-    "supports-color": "9.4.0",
+    "tsconfig-paths": "^4.2.0",
     "unified": "11.0.4",
-    "unified-diff": "5.0.0",
     "unified-engine": "11.2.0",
     "vfile-reporter": "^8.1.0"
   },
   "devDependencies": {
+    "@storm-software/config": "1.7.0",
+    "@storm-software/config-tools": "1.33.0",
     "@types/eslint": "8.44.6"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "peerDependencies": {
+    "@storm-software/config": "workspace:^",
+    "@storm-software/config-tools": "workspace:^"
   }
 }

package/project.json

@@ -0,0 +1,111 @@
+{
+  "name": "linting-tools",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/linting-tools/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/esbuild:esbuild",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/linting-tools",
+        "tsConfig": "packages/linting-tools/tsconfig.json",
+        "project": "packages/linting-tools/package.json",
+        "main": "packages/linting-tools/src/cli/index.ts",
+        "additionalEntryPoints": [
+          "packages/linting-tools/bin/lint.ts",
+          "packages/linting-tools/src/eslint/graphql/index.ts",
+          "packages/linting-tools/src/eslint/javascript/index.ts",
+          "packages/linting-tools/src/eslint/json/index.ts",
+          "packages/linting-tools/src/eslint/jest/index.ts",
+          "packages/linting-tools/src/eslint/next/index.ts",
+          "packages/linting-tools/src/eslint/react/index.ts",
+          "packages/linting-tools/src/eslint/typescript/index.ts",
+          "packages/linting-tools/src/manypkg/index.ts"
+        ],
+        "deleteOutputPath": true,
+        "bundle": true,
+        "sourcemap": false,
+        "minify": false,
+        "skipTypeCheck": true,
+        "thirdParty": true,
+        "format": ["cjs", "esm"],
+        "external": ["nx"],
+        "esbuildOptions": {
+          "legalComments": "inline",
+          "banner": {
+            "js": "const require = (await import('node:module')).createRequire(import.meta.url);const __filename = (await import('node:url')).fileURLToPath(import.meta.url);const __dirname = (await import('node:path')).dirname(__filename);"
+          }
+        },
+        "assets": [
+          {
+            "input": "packages/linting-tools",
+            "glob": "README.md",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools",
+            "glob": "CHANGELOG.md",
+            "output": "."
+          },
+          {
+            "input": "",
+            "glob": "LICENSE",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools",
+            "glob": "bin/**/*",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "alex/**/.{alexrc,alexignore}",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "biome/biome.json",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "taplo/*",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "ls-lint/*",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "cspell/**/dictionary.txt",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "cspell/**/*.json",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/node_modules",
+            "glob": "@cspell/**/cspell-ext.json",
+            "output": "cspell"
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "prettier/**/*.*",
+            "output": "."
+          },
+          {
+            "input": "packages/linting-tools/src",
+            "glob": "tsconfig/**/*.*",
+            "output": "."
+          }
+        ]
+      }
+    }
+  },
+  "tags": ["type:util", "scope:tools"]
+}

package/src/alex/index.ts

@@ -0,0 +1,67 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { filter } from "alex/filter";
+import retextEnglish from "retext-english";
+import retextEquality from "retext-equality";
+import retextProfanities from "retext-profanities";
+import { type PluggableList, unified } from "unified";
+import { engine } from "unified-engine";
+import vfileReporter from "vfile-reporter";
+
+Error.stackTraceLimit = Infinity;
+
+export const runAlex = (
+  rcName = "@storm-software/linting-tools/alex/.alexrc",
+  ignoreName = "@storm-software/linting-tools/alex/.alexignore"
+) => {
+  return new Promise((resolve: (value: unknown) => void, reject: (reason?: any) => void) =>
+    engine(
+      {
+        processor: unified(),
+        files: ["**/*.{txt,js,jsx,ts,tsx,md,mdx,json}"],
+        extensions: ["txt", "text", "md", "mdx", "markdown", "mkd", "mkdn", "mkdown", "ron"],
+        configTransform: transform,
+        out: false,
+        output: false,
+        rcName,
+        rcPath: undefined,
+        packageField: "alex",
+        color: true,
+        reporter: vfileReporter,
+        reporterOptions: {
+          verbose: false
+        },
+        quiet: true,
+        ignoreName,
+        ignorePatterns: ["**/CODE_OF_CONDUCT.md", "**/dist/**", "**/node_modules/**"],
+        silent: false,
+        silentlyIgnore: true,
+        frail: true,
+        defaultConfig: transform({})
+      },
+      (error, code) => {
+        if (error) {
+          console.error(error.message);
+          return reject(code);
+        }
+        return resolve(code);
+      }
+    )
+  );
+};
+
+const transform = (options: any) => {
+  return {
+    plugins: [
+      retextEnglish,
+      [retextProfanities, { sureness: options.profanitySureness }],
+      [retextEquality, { noBinary: options.noBinary }],
+      [
+        filter,
+        {
+          allow: options.allow,
+          deny: options.deny
+        }
+      ]
+    ] as PluggableList
+  };
+};

package/{biome → src/biome}/biome.json

@@ -31,7 +31,8 @@
       "style": {
         "useDefaultParameterLast": "off",
         "useTemplate": "warn",
-        "noUselessElse": "warn"
+        "noUselessElse": "warn",
+        "noNonNullAssertion": "warn"
       },
       "suspicious": {
         "noAssignInExpressions": "warn",