feat: bump prettier and add lib publishing checks

tablecheck · Jul 28, 2023 · 6a61092 · 6a61092
1 parent 2aa346e
commit 6a61092
Show file tree

Hide file tree

Showing 11 changed files with 206 additions and 34 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -68,7 +68,7 @@
     "lodash": "^4.17.21",
     "nx": "16.5.0",
     "nx-cloud": "16.0.5",
-    "prettier": "2.8.8",
+    "prettier": "3.0.0",
     "storybook": "^6.5.16",
     "type-fest": "4.0.0",
     "typescript": "5.1.6",

diff --git a/packages/eslint-config/src/rules/namingConvention.ts b/packages/eslint-config/src/rules/namingConvention.ts
@@ -98,7 +98,7 @@ export const namingRules: Linter.RulesRecord = {
       },
     },
     {
-      selector: ['property'],
+      selector: ['property', 'parameterProperty'],
       format: ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE'],
       leadingUnderscore: 'allowDouble', // double for __html
     },
@@ -109,7 +109,7 @@ export const namingRules: Linter.RulesRecord = {
     },
     {
       selector: 'parameter',
-      format: ['camelCase'],
+      format: ['camelCase', 'PascalCase'],
       leadingUnderscore: 'allow',
     },
   ],

diff --git a/packages/eslint-config/src/rules/react.ts b/packages/eslint-config/src/rules/react.ts
@@ -13,6 +13,12 @@ export const reactRules: Linter.RulesRecord = {
   'react/prop-types': 'off',
   // see https://github.com/jsx-eslint/eslint-plugin-react/issues/3384#issuecomment-1236371796
   'react/no-unknown-property': ['error', { ignore: ['css'] }],
+  'react/no-unstable-nested-components': [
+    'error',
+    {
+      allowAsProps: true,
+    },
+  ],
 
   // These cause typing conflicts
   'react/require-default-props': ['off'],

diff --git a/packages/eslint-plugin/src/shortestImport.ts b/packages/eslint-plugin/src/shortestImport.ts
@@ -53,19 +53,22 @@ export const shortestImport: TSESLint.RuleModule<
           .readdirSync(baseUrl, {
             withFileTypes: true,
           })
-          .reduce((directoryMap, dirrent) => {
-            if (dirrent.isDirectory())
+          .reduce(
+            (directoryMap, dirrent) => {
+              if (dirrent.isDirectory())
+                return {
+                  ...directoryMap,
+                  [dirrent.name]: path.join(relativeBaseUrl, dirrent.name),
+                };
               return {
                 ...directoryMap,
-                [dirrent.name]: path.join(relativeBaseUrl, dirrent.name),
+                [dirrent.name.replace(/\.[^.]+$/gi, '')]: path
+                  .join(relativeBaseUrl, dirrent.name)
+                  .replace(/^\.\//gi, ''),
               };
-            return {
-              ...directoryMap,
-              [dirrent.name.replace(/\.[^.]+$/gi, '')]: path
-                .join(relativeBaseUrl, dirrent.name)
-                .replace(/^\.\//gi, ''),
-            };
-          }, {} as Record<string, string>)
+            },
+            {} as Record<string, string>,
+          )
       : {};
     const compilerPaths = Object.entries(compilerOptions.paths ?? {}).reduce(
       (compilerPathsMap, [key, [value]]) => ({

diff --git a/packages/nx/package.json b/packages/nx/package.json
@@ -32,12 +32,13 @@
     "flat": "5.0.2",
     "fs-extra": "11.1.1",
     "lodash": "4.17.21",
-    "prettier": "^2"
+    "prettier": "^3",
+    "publint": "0.2.0",
+    "tsimportlib": "0.0.5"
   },
   "devDependencies": {
     "@types/flat": "5.0.2",
     "@types/lodash": "4.14.195",
-    "@types/prettier": "2.7.3",
     "type-fest": "4.0.0",
     "typescript": "5.1.6"
   },

diff --git a/packages/nx/src/executors/build-lib/executor.ts b/packages/nx/src/executors/build-lib/executor.ts
@@ -1,15 +1,52 @@
 import { ExecutorContext } from '@nx/devkit';
 import { buildPackage } from '@tablecheck/frontend-library';
+import { dynamicImport } from 'tsimportlib';
 
 import { BuildLibExecutorSchema } from './schema.js';
 
 export default async function runExecutor(
   options: BuildLibExecutorSchema,
   context: ExecutorContext,
 ) {
+  if (!context.projectName) {
+    throw new Error('Lib build must be run on a project');
+  }
   const metadata =
-    context.projectsConfigurations?.projects[context.projectName || '.'];
+    context.projectsConfigurations?.projects[context.projectName];
+  if (!metadata) {
+    throw new Error(
+      `Could not find project configuration for ${context.projectName}`,
+    );
+  }
+  const isBuildSuccessful = await buildPackage({
+    cwd: metadata.root,
+    ...options,
+  });
+
+  const { publint } = (await dynamicImport(
+    'publint',
+    module,
+    // @ts-expect-error - this is a dynamic import
+  )) as typeof import('publint');
+
+  const { messages } = await publint({
+    pkgDir: metadata.root,
+    /**
+     * Report warnings as errors.
+     */
+    strict: true,
+  });
+
   return {
-    success: await buildPackage({ cwd: metadata!.root, ...options }),
+    success: isBuildSuccessful && messages.length === 0,
+    terminalOutput: messages
+      .map((message) => {
+        const { args, code, path, type } = message;
+        return `${type}: ${code}
+  - ${path.join('\n  - ')}
+
+  ${JSON.stringify(args, null, 2)}`;
+      })
+      .join('\n'),
   };
 }
diff --git a/packages/nx/src/executors/quality/executor.ts b/packages/nx/src/executors/quality/executor.ts
@@ -1,3 +1,5 @@
+import { execSync } from 'child_process';
+
 import { ExecutorContext } from '@nx/devkit';
 import lintRun from '@nx/linter/src/executors/eslint/lint.impl.js';
 
@@ -39,6 +41,24 @@ export default async function runExecutor(
       },
       context,
     );
+
+    try {
+      execSync(
+        `npx prettier ${[
+          options.fix ? '-w' : '-c',
+          '--log-level warn',
+          '--no-error-on-unmatched-pattern',
+          '--ignore-unknown',
+          '--cache',
+        ].join(' ')} --log-level warn .`,
+        {
+          cwd: root,
+          stdio: 'inherit',
+        },
+      );
+    } catch (e) {
+      return { success: false };
+    }
     return { success: lintResult.success && packageCheckResult.success };
   } catch (e) {
     console.log(e as Error);