feat: make the repo stricter (#83)

Author: dmitry-stepanenko

.eslintrc.json

@@ -1,7 +1,7 @@
 {
   "root": true,
   "ignorePatterns": ["**/*"],
-  "plugins": ["@nrwl/nx"],
+  "plugins": ["@nrwl/nx", "eslint-plugin-unused-imports"],
   "overrides": [
     {
       "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
@@ -24,7 +24,24 @@
     {
       "files": ["*.ts", "*.tsx"],
       "extends": ["plugin:@nrwl/nx/typescript"],
-      "rules": {}
+      "rules": {
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "unused-imports/no-unused-imports": "error",
+        "no-duplicate-imports": "error",
+        "unused-imports/no-unused-vars": "error",
+        "@typescript-eslint/naming-convention": [
+          "error",
+          {
+            "selector": "enum",
+            "format": ["PascalCase"]
+          },
+          {
+            "selector": "enumMember",
+            "format": ["PascalCase"]
+          }
+        ]
+      }
     },
     {
       "files": ["*.js", "*.jsx"],
@@ -36,7 +53,9 @@
       "env": {
         "jest": true
       },
-      "rules": {}
+      "rules": {
+        "no-restricted-globals": ["error", "fdescribe", "fit"]
+      }
     },
     {
       "files": "*.json",

e2e/qwik-nx-e2e/tests/application.spec.ts

@@ -59,7 +59,7 @@ describe('appGenerator e2e', () => {
         }
       );
       try {
-        await promisifiedTreeKill(p.pid, 'SIGKILL');
+        await promisifiedTreeKill(p.pid!, 'SIGKILL');
         await killPort(port);
       } catch {
         // ignore
@@ -75,7 +75,7 @@ describe('appGenerator e2e', () => {
         }
       );
       try {
-        await promisifiedTreeKill(p.pid, 'SIGKILL');
+        await promisifiedTreeKill(p.pid!, 'SIGKILL');
         await killPort(port);
       } catch {
         // ignore

e2e/qwik-nx-e2e/tests/qwik-nx-vite.spec.ts

@@ -127,7 +127,7 @@ describe('qwikNxVite plugin e2e', () => {
         }
       );
       try {
-        await promisifiedTreeKill(p.pid, 'SIGKILL');
+        await promisifiedTreeKill(p.pid!, 'SIGKILL');
         await killPort(port);
       } catch {
         // ignore

e2e/utils/index.ts

@@ -20,27 +20,31 @@ export const promisifiedTreeKill: (
   signal: string
 ) => Promise<void> = promisify(treeKill);
 
-function getAdditionalPackageManagerCommands() {
+function getAdditionalPackageManagerCommands(): {
+  createWorkspace: string;
+  runNx: string;
+} {
   const pm = detectPackageManager();
   const [npmMajorVersion] = execSync(`npm -v`).toString().split('.');
   const publishedVersion = execSync('npm view nx version');
-  if (pm === 'npm') {
-    return {
-      createWorkspace: `npx ${
-        +npmMajorVersion >= 7 ? '--yes' : ''
-      } create-nx-workspace@${publishedVersion}`,
-      runNx: `npx nx`,
-    };
-  } else if (pm === 'yarn') {
-    return {
-      createWorkspace: `yarn global add create-nx-workspace@${publishedVersion} && create-nx-workspace`,
-      runNx: `yarn nx`,
-    };
-  } else if (pm === 'pnpm') {
-    return {
-      createWorkspace: `pnpm dlx create-nx-workspace@${publishedVersion}`,
-      runNx: `pnpm exec nx`,
-    };
+  switch (pm) {
+    case 'npm':
+      return {
+        createWorkspace: `npx ${
+          +npmMajorVersion >= 7 ? '--yes' : ''
+        } create-nx-workspace@${publishedVersion}`,
+        runNx: `npx nx`,
+      };
+    case 'yarn':
+      return {
+        createWorkspace: `yarn global add create-nx-workspace@${publishedVersion} && create-nx-workspace`,
+        runNx: `yarn nx`,
+      };
+    case 'pnpm':
+      return {
+        createWorkspace: `pnpm dlx create-nx-workspace@${publishedVersion}`,
+        runNx: `pnpm exec nx`,
+      };
   }
 }
 
@@ -149,7 +153,7 @@ export function runCommandUntil(
     let output = '';
     let complete = false;
 
-    function checkCriteria(c) {
+    function checkCriteria(c: any) {
       output += c.toString();
       if (criteria(stripConsoleColors(output)) && !complete) {
         complete = true;

package.json

@@ -31,8 +31,10 @@
     "@swc-node/register": "^1.4.2",
     "@swc/cli": "~0.1.55",
     "@swc/core": "^1.2.173",
+    "@types/fs-extra": "11.0.1",
     "@types/jest": "28.1.1",
     "@types/node": "16.11.7",
+    "@types/tcp-port-used": "1.0.1",
     "@typescript-eslint/eslint-plugin": "^5.36.1",
     "@typescript-eslint/parser": "^5.36.1",
     "all-contributors-cli": "^6.24.0",
@@ -42,8 +44,10 @@
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "~8.15.0",
     "eslint-config-prettier": "8.1.0",
+    "eslint-plugin-unused-imports": "2.0.0",
     "fs-extra": "11.1.0",
     "husky": "^8.0.1",
+    "is-windows": "1.0.2",
     "jest": "28.1.1",
     "jest-environment-jsdom": "28.1.1",
     "jsonc-eslint-parser": "^2.1.0",

packages/add-nx-to-qwik/src/add-nx-to-qwik.ts

@@ -44,7 +44,7 @@ async function addNxToMonorepo() {
 
   let targetDefaults: string[];
   let cacheableOperations: string[];
-  let scriptOutputs = {};
+  const scriptOutputs = {};
   let useCloud: boolean;
 
   if (parsedArgs.yes !== true) {

packages/qwik-nx/src/generators/application/generator.spec.ts

@@ -7,6 +7,7 @@ import { Linter } from '@nrwl/linter';
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const devkit = require('@nrwl/devkit');
+const getInstalledNxVersionModule = require('../../utils/get-installed-nx-version');
 
 describe('qwik-nx generator', () => {
   let appTree: Tree;
@@ -21,6 +22,9 @@ describe('qwik-nx generator', () => {
   };
 
   jest.spyOn(devkit, 'ensurePackage').mockReturnValue(Promise.resolve());
+  jest
+    .spyOn(getInstalledNxVersionModule, 'getInstalledNxVersion')
+    .mockReturnValue('15.6.0');
 
   beforeEach(() => {
     appTree = createTreeWithEmptyWorkspace({ layout: 'apps-libs' });
@@ -50,7 +54,7 @@ describe('qwik-nx generator', () => {
       });
       const config = readProjectConfiguration(appTree, 'myapp-e2e');
       expect(config).toBeDefined();
-      expect(config.targets.e2e.executor).toEqual('@nxkit/playwright:test');
+      expect(config.targets?.e2e.executor).toEqual('@nxkit/playwright:test');
       expect(
         appTree.exists('apps/myapp-e2e/playwright.config.ts')
       ).toBeTruthy();
@@ -63,7 +67,7 @@ describe('qwik-nx generator', () => {
       });
       const config = readProjectConfiguration(appTree, 'myapp-e2e');
       expect(config).toBeDefined();
-      expect(config.targets.e2e.executor).toEqual('@nrwl/cypress:cypress');
+      expect(config.targets?.e2e.executor).toEqual('@nrwl/cypress:cypress');
       expect(appTree.exists('apps/myapp-e2e/cypress.config.ts')).toBeTruthy();
     });
   });

packages/qwik-nx/src/generators/application/generator.ts

@@ -5,6 +5,7 @@ import {
   GeneratorCallback,
   joinPathFragments,
   names,
+  TargetConfiguration,
   Tree,
 } from '@nrwl/devkit';
 import { Linter } from '@nrwl/linter';
@@ -41,7 +42,8 @@ export async function appGenerator(
   const normalizedOptions = normalizeOptions(tree, options);
   const tasks: GeneratorCallback[] = [];
 
-  const targets = getQwikApplicationProjectTargets(normalizedOptions);
+  const targets: Record<string, TargetConfiguration> =
+    getQwikApplicationProjectTargets(normalizedOptions);
 
   if (!normalizedOptions.setupVitest) {
     delete targets['test'];
@@ -69,15 +71,18 @@ export async function appGenerator(
     tasks.push(configureEslint(tree, normalizedOptions.projectName, true));
   }
 
-  if (normalizedOptions.style !== 'none') {
+  if (normalizedOptions.styleExtension) {
     tasks.push(
       addStyledModuleDependencies(tree, normalizedOptions.styleExtension)
     );
   }
 
   tasks.push(addCommonQwikDependencies(tree));
 
-  if (normalizedOptions.e2eTestRunner !== 'none') {
+  if (
+    normalizedOptions.e2eTestRunner &&
+    normalizedOptions.e2eTestRunner !== 'none'
+  ) {
     const e2eProjectTask = await addE2eProject(tree, {
       project: normalizedOptions.projectName,
       directory: normalizedOptions.directory,

packages/qwik-nx/src/generators/application/utils/get-qwik-application-project-params.ts

@@ -8,7 +8,7 @@ export interface UpdateQwikAppConfigurationParams {
 
 export function getQwikApplicationProjectTargets(
   params: UpdateQwikAppConfigurationParams
-) {
+): Record<string, TargetConfiguration> {
   return {
     build: getBuildTarget(params),
     'build-ssr': getBuildSsrTarget(params),

packages/qwik-nx/src/generators/component/generator.ts

@@ -1,6 +1,7 @@
 import {
   formatFiles,
   generateFiles,
+  GeneratorCallback,
   getProjects,
   joinPathFragments,
   logger,
@@ -23,7 +24,7 @@ function getDirectory(host: Tree, options: ComponentGeneratorSchema) {
     baseDir = options.directory;
   } else {
     baseDir =
-      workspace.get(options.project).projectType === 'application'
+      workspace.get(options.project)!.projectType === 'application'
         ? 'components'
         : 'lib';
   }
@@ -45,7 +46,8 @@ function normalizeOptions(
     throw new Error();
   }
 
-  const { sourceRoot: projectRoot } = project;
+  const projectRoot =
+    project.sourceRoot ?? joinPathFragments(project.root, 'src');
 
   const directory = getDirectory(host, options);
 
@@ -98,7 +100,7 @@ function createComponentFiles(tree: Tree, options: NormalizedSchema) {
 export async function componentGenerator(
   tree: Tree,
   options: ComponentGeneratorSchema
-) {
+): Promise<GeneratorCallback> {
   const normalizedOptions = normalizeOptions(tree, options);
   createComponentFiles(tree, normalizedOptions);
   await formatFiles(tree);