fix(monorepo): Resolve issue with markdown across entire monorepo

storm-software · Oct 8, 2024 · ee6720c · ee6720c
1 parent 6822f77
commit ee6720c
Show file tree

Hide file tree

Showing 27 changed files with 90 additions and 720 deletions.
diff --git a/apps/nx/README.md b/apps/nx/README.md
@@ -38,44 +38,18 @@ This package is part of the ⚡<b>Storm Stack</b> monorepo. Storm Stack packages
 
 <br />
 
-<!-- START doctoc -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-## Table of Contents
-
-- [Storm-Stack Nx Tools](#storm-stack-nx-tools)
-  - [Installing](#installing)
-  - [Executors](#executors)
-  - [Storm-Stack Tamagui Compiler](#storm-stack-tamagui-compiler)
-    - [Example](#example)
-  - [Generators](#generators)
-  - [Building](#building)
-  - [Running unit tests](#running-unit-tests)
-  - [Storm Workspaces](#storm-workspaces)
-  - [Roadmap](#roadmap)
-  - [Support](#support)
-  - [License](#license)
-  - [Changelog](#changelog)
-  - [Contributing](#contributing)
-  - [Contributors](#contributors)
-
-<!-- END doctoc -->
-
-<br />
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- END header -->
 
 # Storm-Stack Nx Tools
 
 A package containing tools for managing a Storm workspace. It includes various
 [Nx](https://nx.dev) generators and executors for common development tasks.
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- END doctoc -->
+
+<br />
 
 This library was generated with [Nx](https://nx.dev).
 

diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -33,7 +33,7 @@ export default getStormConfig({
     "function-paren-newline": 0,
     "space-before-function-paren": 0
   },
-  markdown: false,
+  markdown: true,
   react: false,
   tsConfigType: "recommended",
   useUnicorn: true

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -38,29 +38,6 @@ This package is part of the ⚡<b>Storm Stack</b> monorepo. Storm Stack packages
 
 <br />
 
-<!-- START doctoc -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-## Table of Contents
-
-- [Command Line Utility Library](#command-line-utility-library)
-  - [Table of Contents](#table-of-contents)
-  - [Installing](#installing)
-  - [Reduced Package Size](#reduced-package-size)
-  - [Development](#development)
-    - [Building](#building)
-    - [Running unit tests](#running-unit-tests)
-    - [Linting](#linting)
-  - [Storm Workspaces](#storm-workspaces)
-  - [Roadmap](#roadmap)
-  - [Support](#support)
-  - [License](#license)
-  - [Changelog](#changelog)
-  - [Contributing](#contributing)
-  - [Contributors](#contributors)
-
-<!-- END doctoc -->
-
-<br />
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
@@ -74,25 +51,10 @@ A collection of CLI utilities to assist in creating command line applications
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-## Table of Contents
-
-- [Installing](#installing)
-- [Reduced Package Size](#reduced-package-size)
-- [Development](#development)
-  - [Building](#building)
-  - [Running unit tests](#running-unit-tests)
-  - [Linting](#linting)
-- [Storm Workspaces](#storm-workspaces)
-- [Roadmap](#roadmap)
-- [Support](#support)
-- [License](#license)
-- [Changelog](#changelog)
-- [Contributing](#contributing)
-- [Contributors](#contributors)
-  - [💻 Visit stormsoftware.org to stay up to date with this developer](#-visit-stormsoftwareorg-to-stay-up-to-date-with-this-developer)
-
 <!-- END doctoc -->
 
+<br />
+
 ## Installing
 
 Using [pnpm](http://pnpm.io):

diff --git a/packages/date-time/README.md b/packages/date-time/README.md
@@ -38,30 +38,6 @@ This package is part of the ⚡<b>Storm Stack</b> monorepo. Storm Stack packages
 
 <br />
 
-<!-- START doctoc -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-## Table of Contents
-
-- [Storm Date-Time Package](#storm-date-time-package)
-  - [Table of Contents](#table-of-contents)
-  - [Installing](#installing)
-  - [Reduced Package Size](#reduced-package-size)
-  - [Development](#development)
-    - [Building](#building)
-    - [Running unit tests](#running-unit-tests)
-    - [Linting](#linting)
-  - [Storm Workspaces](#storm-workspaces)
-  - [Roadmap](#roadmap)
-  - [Support](#support)
-  - [License](#license)
-  - [Changelog](#changelog)
-  - [Contributing](#contributing)
-  - [Contributors](#contributors)
-
-<!-- END doctoc -->
-
-<br />
-
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
@@ -77,25 +53,10 @@ environment.
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-## Table of Contents
-
-- [Installing](#installing)
-- [Reduced Package Size](#reduced-package-size)
-- [Development](#development)
-  - [Building](#building)
-  - [Running unit tests](#running-unit-tests)
-  - [Linting](#linting)
-- [Storm Workspaces](#storm-workspaces)
-- [Roadmap](#roadmap)
-- [Support](#support)
-- [License](#license)
-- [Changelog](#changelog)
-- [Contributing](#contributing)
-- [Contributors](#contributors)
-  - [💻 Visit stormsoftware.org to stay up to date with this developer](#-visit-stormsoftwareorg-to-stay-up-to-date-with-this-developer)
-
 <!-- END doctoc -->
 
+<br />
+
 ## Installing
 
 Using [pnpm](http://pnpm.io):

diff --git a/packages/errors/README.md b/packages/errors/README.md
@@ -38,30 +38,6 @@ This package is part of the ⚡<b>Storm Stack</b> monorepo. Storm Stack packages
 
 <br />
 
-<!-- START doctoc -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-## Table of Contents
-
-- [Storm Errors Package](#storm-errors-package)
-  - [Table of Contents](#table-of-contents)
-  - [Installing](#installing)
-  - [Reduced Package Size](#reduced-package-size)
-  - [Development](#development)
-    - [Building](#building)
-    - [Running unit tests](#running-unit-tests)
-    - [Linting](#linting)
-  - [Storm Workspaces](#storm-workspaces)
-  - [Roadmap](#roadmap)
-  - [Support](#support)
-  - [License](#license)
-  - [Changelog](#changelog)
-  - [Contributing](#contributing)
-  - [Contributors](#contributors)
-
-<!-- END doctoc -->
-
-<br />
-
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
@@ -76,25 +52,10 @@ throughout your application.
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-## Table of Contents
-
-- [Installing](#installing)
-- [Reduced Package Size](#reduced-package-size)
-- [Development](#development)
-  - [Building](#building)
-  - [Running unit tests](#running-unit-tests)
-  - [Linting](#linting)
-- [Storm Workspaces](#storm-workspaces)
-- [Roadmap](#roadmap)
-- [Support](#support)
-- [License](#license)
-- [Changelog](#changelog)
-- [Contributing](#contributing)
-- [Contributors](#contributors)
-  - [💻 Visit stormsoftware.org to stay up to date with this developer](#-visit-stormsoftwareorg-to-stay-up-to-date-with-this-developer)
-
 <!-- END doctoc -->
 
+<br />
+
 ## Installing
 
 Using [pnpm](http://pnpm.io):

diff --git a/packages/file-system/README.md b/packages/file-system/README.md
@@ -38,30 +38,6 @@ This package is part of the ⚡<b>Storm Stack</b> monorepo. Storm Stack packages
 
 <br />
 
-<!-- START doctoc -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-## Table of Contents
-
-- [file-system](#file-system)
-  - [Table of Contents](#table-of-contents)
-  - [Installing](#installing)
-  - [Reduced Package Size](#reduced-package-size)
-  - [Development](#development)
-    - [Building](#building)
-    - [Running unit tests](#running-unit-tests)
-    - [Linting](#linting)
-  - [Storm Workspaces](#storm-workspaces)
-  - [Roadmap](#roadmap)
-  - [Support](#support)
-  - [License](#license)
-  - [Changelog](#changelog)
-  - [Contributing](#contributing)
-  - [Contributors](#contributors)
-
-<!-- END doctoc -->
-
-<br />
-
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
@@ -74,25 +50,10 @@ A utility package containing various methods used to manipulate files
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-## Table of Contents
-
-- [Installing](#installing)
-- [Reduced Package Size](#reduced-package-size)
-- [Development](#development)
-  - [Building](#building)
-  - [Running unit tests](#running-unit-tests)
-  - [Linting](#linting)
-- [Storm Workspaces](#storm-workspaces)
-- [Roadmap](#roadmap)
-- [Support](#support)
-- [License](#license)
-- [Changelog](#changelog)
-- [Contributing](#contributing)
-- [Contributors](#contributors)
-  - [💻 Visit stormsoftware.org to stay up to date with this developer](#-visit-stormsoftwareorg-to-stay-up-to-date-with-this-developer)
-
 <!-- END doctoc -->
 
+<br />
+
 ## Installing
 
 Using [pnpm](http://pnpm.io):

diff --git a/packages/file-system/src/files/file-path-fns.ts b/packages/file-system/src/files/file-path-fns.ts
@@ -110,7 +110,7 @@ export function hasFilePath(filePath: string): boolean {
  */
 export function resolvePath(
   filePath: string,
-  basePath: string = getWorkspaceRoot()
+  basePath: string = getWorkspaceRoot() as string
 ) {
   if (isAbsolute(filePath)) {
     return filePath;
@@ -129,7 +129,7 @@ export function resolvePath(
  * @returns The resolved file path
  */
 export function relativeToWorkspaceRoot(filePath: string) {
-  return relative(filePath, getWorkspaceRoot());
+  return relative(filePath, getWorkspaceRoot() as string);
 }
 
 /**

diff --git a/packages/file-system/src/package-management/get-tsconfig.ts b/packages/file-system/src/package-management/get-tsconfig.ts
@@ -65,6 +65,7 @@ const stripJsonComments = (
       }
     }
     if (isInsideString) {
+      // eslint-disable-next-line no-continue
       continue;
     }
     if (
@@ -113,6 +114,7 @@ const stripJsonComments = (
           commaIndex = -1;
         } else if (
           currentCharacter !== " " &&
+          // eslint-disable-next-line no-tabs
           currentCharacter !== "	" &&
           currentCharacter !== "\r" &&
           currentCharacter !== "\n"
@@ -140,6 +142,7 @@ const stripJsonComments = (
 
 const jsoncParse = (data: string) => {
   try {
+    // eslint-disable-next-line no-new-func
     return new Function(`return ${stripJsonComments(data).trim()}`)();
   } catch {
     return {};
@@ -166,8 +169,9 @@ const findUp = (
 };
 
 const resolveTsConfigFromFile = (cwd: string, filename: string) => {
-  if (path.isAbsolute(filename))
+  if (path.isAbsolute(filename)) {
     return fs.existsSync(filename) ? filename : null;
+  }
   return findUp(filename, cwd);
 };
 
@@ -197,7 +201,7 @@ const loadTsConfigInternal = (
 
   const data = jsoncParse(fs.readFileSync(id, "utf8"));
   const configDir = path.dirname(id);
-  // biome-ignore lint/suspicious/noAssignInExpressions: <explanation>
+  // eslint-disable-next-line no-cond-assign
   if ((_a = data.compilerOptions) === null ? void 0 : _a.baseUrl) {
     data.compilerOptions.baseUrl = path.join(
       configDir,
@@ -214,11 +218,13 @@ const loadTsConfigInternal = (
       const parentConfig: any = loadTsConfigInternal(configDir, name2, true);
       if (parentConfig) {
         Object.assign(extendsData, {
-          ...(parentConfig == null ? void 0 : parentConfig.data),
+          ...(parentConfig === null ? void 0 : parentConfig.data),
           compilerOptions: {
             ...extendsData.compilerOptions,
-            // biome-ignore lint/suspicious/noAssignInExpressions: <explanation>
-            ...((_b = parentConfig == null ? void 0 : parentConfig.data) == null
+
+            // eslint-disable-next-line no-cond-assign
+            ...((_b = parentConfig === null ? void 0 : parentConfig.data) ===
+            null
               ? void 0
               : _b.compilerOptions)
           }

diff --git a/packages/file-system/src/package-management/index.ts b/packages/file-system/src/package-management/index.ts
@@ -15,6 +15,7 @@
 
  -------------------------------------------------------------------*/
 
+export * from "./chmod";
 export * from "./get-tsconfig";
 export * from "./package-fns";
 export * from "./semver-fns";
diff --git a/packages/file-system/src/package-management/package-fns.ts b/packages/file-system/src/package-management/package-fns.ts
@@ -30,7 +30,7 @@ export const PackageManagers = {
 
 function findUp(names: string[], cwd: string): string | undefined {
   let dir = cwd;
-  // eslint-disable-next-line no-constant-condition
+
   while (true) {
     const target = names.find(name => exists(joinPaths(dir, name)));
     if (target) return target;
@@ -77,7 +77,9 @@ export function installPackage(
   exactVersion = true
 ) {
   const manager = pkgManager ?? getPackageManager(projectPath);
+  // eslint-disable-next-line no-console
   console.log(`Installing package "${pkg}@${tag}" with ${manager}`);
+
   switch (manager) {
     case "yarn": {
       execute(