feat(sage-monorepo): explore Nx executors to standardize tasks across projects

.vscode/extensions.json

@@ -1,4 +1,3 @@
 {
-  // Extensions should be defined in `.devcontainer/devcontainer.json` instead of here.
-  "recommendations": []
-}
+  "recommendations": ["esbenp.prettier-vscode", "firsttris.vscode-jest-runner"]
+}

.vscode/settings.json

@@ -12,21 +12,11 @@
     "editor.defaultFormatter": "ms-python.black-formatter",
     "editor.formatOnSave": true,
     "editor.tabSize": 4
-    // This settings still works even if VS Code does not recognize it.
-    // "notebook.formatOnSave.enabled": true
   },
   "[json][jsonc]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true
   },
-  // "[typescript]": {
-  //   "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-  //   "editor.formatOnSave": false
-  // },
-  // "[javascript]": {
-  //   "editor.defaultFormatter": "dbaeumer.vscode-eslint",
-  //   "editor.formatOnSave": true
-  // },
   "java.format.enabled": false,
   "[java]": {
     "editor.formatOnSave": false
@@ -47,14 +37,6 @@
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true
   },
-  // "emeraldwalk.runonsave": {
-  //   "commands": [
-  //     {
-  //       "match": "\\.(java|sql)$",
-  //       "cmd": "node_modules/.bin/nx affected --base=HEAD --target=format"
-  //     }
-  //   ]
-  // },
   "eslint.workingDirectories": ["."],
   "sqltools.autoOpenSessionFiles": false,
   "sqltools.connections": [

libs/openchallenges/api-description/project.json

@@ -45,6 +45,9 @@
       "options": {
         "command": "prettier --check {projectRoot}"
       }
+    },
+    "about": {
+      "executor": "@sagebionetworks/sage-monorepo:about"
     }
   },
   "tags": [],

libs/sage-monorepo/.eslintrc.json

@@ -0,0 +1,32 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "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"
+      }
+    },
+    {
+      "files": ["./package.json", "./executors.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/nx-plugin-checks": "error"
+      }
+    }
+  ]
+}

libs/sage-monorepo/README.md

@@ -0,0 +1,11 @@
+# sage-monorepo
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build sage-monorepo` to build the library.
+
+## Running unit tests
+
+Run `nx test sage-monorepo` to execute the unit tests via [Jest](https://jestjs.io).

libs/sage-monorepo/executors.json

@@ -0,0 +1,9 @@
+{
+  "executors": {
+    "about": {
+      "implementation": "./src/executors/about/executor",
+      "schema": "./src/executors/about/schema.json",
+      "description": "about executor"
+    }
+  }
+}

libs/sage-monorepo/jest.config.ts

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

libs/sage-monorepo/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "sage-monorepo",
+  "version": "0.0.1",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "private": true,
+  "executors": "./executors.json"
+}

libs/sage-monorepo/project.json

@@ -0,0 +1,29 @@
+{
+  "name": "sage-monorepo",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/sage-monorepo/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/sage-monorepo",
+        "main": "libs/sage-monorepo/src/index.ts",
+        "tsConfig": "libs/sage-monorepo/tsconfig.lib.json",
+        "assets": ["libs/sage-monorepo/*.md"]
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/sage-monorepo/jest.config.ts"
+      }
+    }
+  },
+  "tags": []
+}

libs/sage-monorepo/src/executors/about/executor.ts

@@ -0,0 +1,8 @@
+import { AboutExecutorSchema } from './schema';
+
+export default async function runExecutor(options: AboutExecutorSchema) {
+  console.log('Executor ran for About', options);
+  return {
+    success: true,
+  };
+}

libs/sage-monorepo/src/executors/about/schema.d.ts

@@ -0,0 +1 @@
+export interface AboutExecutorSchema {} // eslint-disable-line

libs/sage-monorepo/src/executors/about/schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "version": 2,
+  "title": "About executor",
+  "description": "",
+  "type": "object",
+  "properties": {},
+  "required": []
+}

libs/sage-monorepo/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/sage-monorepo';

libs/sage-monorepo/src/lib/sage-monorepo.ts

@@ -0,0 +1,3 @@
+export function sageMonorepo(): string {
+  return 'sage-monorepo';
+}

libs/sage-monorepo/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/sage-monorepo/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

libs/sage-monorepo/tsconfig.spec.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}

nx.json

@@ -70,6 +70,11 @@
         "{workspaceRoot}/.eslintrc.json",
         "{workspaceRoot}/tools/eslint-rules/**/*"
       ]
+    },
+    "@nx/js:tsc": {
+      "cache": true,
+      "dependsOn": ["^build"],
+      "inputs": ["production", "^production"]
     }
   },
   "namedInputs": {

package.json

@@ -122,6 +122,7 @@
     "ibm-openapi-validator": "1.7.0",
     "jest": "29.4.3",
     "jest-environment-jsdom": "29.4.3",
+    "jest-environment-node": "^29.4.1",
     "jest-preset-angular": "14.0.3",
     "jsonc-eslint-parser": "2.1.0",
     "ng-packagr": "17.2.1",

tsconfig.base.json

@@ -10,46 +10,89 @@
     "importHelpers": true,
     "target": "es2015",
     "module": "esnext",
-    "lib": ["es2017", "dom"],
+    "lib": [
+      "es2017",
+      "dom"
+    ],
     "skipLibCheck": true,
     "skipDefaultLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "strict": true,
     "baseUrl": ".",
     "paths": {
-      "@sagebionetworks/openchallenges/about": ["libs/openchallenges/about/src/index.ts"],
+      "@sagebionetworks/openchallenges/about": [
+        "libs/openchallenges/about/src/index.ts"
+      ],
       "@sagebionetworks/openchallenges/api-client-angular": [
         "libs/openchallenges/api-client-angular/src/index.ts"
       ],
-      "@sagebionetworks/openchallenges/assets": ["libs/openchallenges/assets/src/index.ts"],
-      "@sagebionetworks/openchallenges/auth": ["libs/openchallenges/auth/src/index.ts"],
-      "@sagebionetworks/openchallenges/challenge": ["libs/openchallenges/challenge/src/index.ts"],
+      "@sagebionetworks/openchallenges/assets": [
+        "libs/openchallenges/assets/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/auth": [
+        "libs/openchallenges/auth/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/challenge": [
+        "libs/openchallenges/challenge/src/index.ts"
+      ],
       "@sagebionetworks/openchallenges/challenge-search": [
         "libs/openchallenges/challenge-search/src/index.ts"
       ],
-      "@sagebionetworks/openchallenges/config": ["libs/openchallenges/config/src/index.ts"],
-      "@sagebionetworks/openchallenges/home": ["libs/openchallenges/home/src/index.ts"],
-      "@sagebionetworks/openchallenges/login": ["libs/openchallenges/login/src/index.ts"],
-      "@sagebionetworks/openchallenges/not-found": ["libs/openchallenges/not-found/src/index.ts"],
+      "@sagebionetworks/openchallenges/config": [
+        "libs/openchallenges/config/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/home": [
+        "libs/openchallenges/home/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/login": [
+        "libs/openchallenges/login/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/not-found": [
+        "libs/openchallenges/not-found/src/index.ts"
+      ],
       "@sagebionetworks/openchallenges/org-profile": [
         "libs/openchallenges/org-profile/src/index.ts"
       ],
-      "@sagebionetworks/openchallenges/org-search": ["libs/openchallenges/org-search/src/index.ts"],
-      "@sagebionetworks/openchallenges/pages": ["libs/openchallenges/pages/src/index.ts"],
-      "@sagebionetworks/openchallenges/signup": ["libs/openchallenges/signup/src/index.ts"],
-      "@sagebionetworks/openchallenges/styles": ["libs/openchallenges/styles/src/index.ts"],
-      "@sagebionetworks/openchallenges/team": ["libs/openchallenges/team/src/index.ts"],
-      "@sagebionetworks/openchallenges/themes": ["libs/openchallenges/themes/src/index.ts"],
-      "@sagebionetworks/openchallenges/ui": ["libs/openchallenges/ui/src/index.ts"],
+      "@sagebionetworks/openchallenges/org-search": [
+        "libs/openchallenges/org-search/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/pages": [
+        "libs/openchallenges/pages/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/signup": [
+        "libs/openchallenges/signup/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/styles": [
+        "libs/openchallenges/styles/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/team": [
+        "libs/openchallenges/team/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/themes": [
+        "libs/openchallenges/themes/src/index.ts"
+      ],
+      "@sagebionetworks/openchallenges/ui": [
+        "libs/openchallenges/ui/src/index.ts"
+      ],
       "@sagebionetworks/openchallenges/user-profile": [
         "libs/openchallenges/user-profile/src/index.ts"
       ],
-      "@sagebionetworks/openchallenges/util": ["libs/openchallenges/util/src/index.ts"],
-      "@sagebionetworks/shared/util": ["libs/shared/typescript/util/src/index.ts"],
+      "@sagebionetworks/openchallenges/util": [
+        "libs/openchallenges/util/src/index.ts"
+      ],
+      "@sagebionetworks/shared/util": [
+        "libs/shared/typescript/util/src/index.ts"
+      ],
       "@sagebionetworks/shared/web-components": [
         "libs/shared/typescript/web-components/src/index.ts"
+      ],
+      "@sagebionetworks/sage-monorepo": [
+        "libs/sage-monorepo/src/index.ts"
       ]
     }
   },
-  "exclude": ["node_modules", "tmp"]
-}
+  "exclude": [
+    "node_modules",
+    "tmp"
+  ]
+}