@leyman/nx-plugin 0.1.0 → 0.2.0

package/README.md

@@ -136,10 +136,12 @@ nx g @leyman/nx-plugin:init
 
 Sets the workspace up for the plugin, leaving alone anything already set:
 
-- `nx.json`: the plugin, and [nx-lifecycle](https://www.npmjs.com/package/nx-lifecycle)'s plugin with the stages install, prepare (generate, format), check (lint), build (run, post, sync), test (compile, run, report) and verify, and each target bound to one, under the name the options give it. `--lifecycle=false` leaves nx-lifecycle out.
-- `devDependencies` of the root `package.json`: the plugin, `@leyman/configs`, `@biomejs/biome`, `@leyman/check-package`, `@nx/js` and `nx-lifecycle`.
+- `nx.json`: the plugin, with `checkPackage.profile` `esm-only` for the packages the `package` generator writes, and [nx-lifecycle](https://www.npmjs.com/package/nx-lifecycle)'s plugin with the stages install, prepare (generate, format), check (lint), build (run, post, sync), test (compile, run, report) and verify, and each target bound to one, under the name the options give it. As every target is bound before any project has it, nx-lifecycle's `warnUnusedBindings` is off. `--lifecycle=false` leaves nx-lifecycle out.
+- `devDependencies` of the root `package.json`: the plugin, `@leyman/configs`, `@biomejs/biome`, `@leyman/check-package`, `@nx/js`, `@typescript/native` (TypeScript 7, the `tsc` the targets run) and `nx-lifecycle`.
 - `biome.json`, extending `@leyman/configs/biome.base.json`.
-- `pnpm-workspace.yaml`, if there is one: `injectWorkspacePackages: true` and `dedupeInjectedDeps: false`, so dependents get workspace packages as published, which `sync-injected` keeps current.
+- `tsconfig.json`, with no files, for Nx's TypeScript sync generator to keep a reference to each package in.
+- `.gitignore`: `node_modules`, `dist`, `dist-test`, and what the targets and Nx write at the root (`.coverage`, `.package-surface`, `.nx/cache` and `.nx/workspace-data`). check-package reads it for the files a package doesn't publish.
+- `pnpm-workspace.yaml`, if there is one: `injectWorkspacePackages: true` and `dedupeInjectedDeps: false`, so dependents get workspace packages as published, which `sync-injected` keeps current, and `allowBuilds` `false` for `nx` and `@swc/core`, whose install scripts pnpm otherwise stops on.
 - `.claude/skills/principles/SKILL.md`, pointing coding agents at the [principles](https://jacobley.github.io/leyman/framework/principles) of the setup. `--skill=false` leaves it out.
 
 Then it installs the dependencies, unless `--skipInstall`.
@@ -179,7 +181,7 @@ Set the ones a workspace always passes as defaults in `nx.json`:
 }
 ```
 
-Each dependency's version comes from the workspace if it can: `workspace:^` for one of its own packages, `catalog:` for one in the pnpm catalog (`catalog:node-{floor}` for a published package's `@types/node`), or the range another package already uses. Otherwise it is the version this plugin was published with, and a package with none of those fails.
+Each dependency's version comes from the workspace if it can: `workspace:^` for one of its own packages, `catalog:` for one in the pnpm catalog (`catalog:node-{floor}` for a published package's `@types/node`), or the range another package (or the root `package.json`) already uses. Nx's own plugins, such as `@nx/js`, otherwise take the range of `nx`. Otherwise it is the version this plugin was published with, and a package with none of those fails.
 
 ## The targets executor
 

package/dist/generators/init.d.ts

@@ -68,8 +68,9 @@ export declare const lifecycleBindings: {
 };
 /**
  * Nx generator setting an Nx workspace up for the plugin: adds it (and nx-lifecycle, with stages and bindings for its
- * targets) to `nx.json`, installs it and the tools its targets run at the root, extends the shared Biome config, has
- * pnpm inject workspace packages, and points coding agents at the principles. Run by `nx add @leyman/nx-plugin`.
+ * targets) to `nx.json`, installs it and the tools its targets run at the root, extends the shared Biome config, writes
+ * a root `tsconfig.json`, has pnpm inject workspace packages and skip install scripts the targets don't need, ignores
+ * what the targets write in `.gitignore`, and points coding agents at the principles. Run by `nx add @leyman/nx-plugin`.
  * Leaves alone what is already set.
  *
  * @param tree - Nx's view of the files

package/dist/generators/init.js

@@ -1,5 +1,5 @@
 import { installPackagesTask, readJson, readNxJson, writeJson } from '@nx/devkit';
-import { parse } from 'yaml';
+import { parseDocument, stringify } from 'yaml';
 import { resolveOptions } from '../lib/options.js';
 import { name as pluginName } from '../lib/plugin.js';
 import { assertOptions } from '../lib/schema.js';
@@ -76,7 +76,12 @@ const rootDependencies = [
     '@biomejs/biome',
     '@leyman/check-package',
     '@leyman/configs',
-    '@nx/js'
+    '@nx/js',
+    "@typescript/native"
+];
+const skippedBuilds = [
+    '@swc/core',
+    'nx'
 ];
 const principlesSkill = `---
 name: principles
@@ -95,25 +100,73 @@ injectWorkspacePackages: true
 const dedupeSettings = `# Otherwise pnpm symlinks to the source again whenever peers allow it
 dedupeInjectedDeps: false
 `;
-const injectWorkspacePackages = (tree)=>{
+const ignoredPaths = [
+    'node_modules',
+    'dist',
+    'dist-test',
+    '/.coverage',
+    '/.package-surface',
+    '/.nx/cache',
+    '/.nx/workspace-data'
+];
+const ignoreOutputs = (tree)=>{
+    const gitignore = tree.read('.gitignore', 'utf8') ?? '';
+    const lines = new Set(gitignore.split('\n').map((line)=>line.trim()));
+    const missing = ignoredPaths.filter((path)=>!lines.has(path));
+    if (missing.length === 0) {
+        return;
+    }
+    const separator = gitignore === '' || gitignore.endsWith('\n') ? '' : '\n';
+    const added = missing.map((path)=>`${path}\n`).join('');
+    tree.write('.gitignore', `${gitignore}${separator}${added}`);
+};
+const configurePnpm = (tree)=>{
     const yaml = tree.read('pnpm-workspace.yaml', 'utf8');
     if (yaml === null) {
         return;
     }
-    const settings = parse(yaml) ?? {};
+    const document = parseDocument(yaml);
+    const missingBuilds = skippedBuilds.filter((name)=>!document.hasIn([
+            'allowBuilds',
+            name
+        ]));
+    const hasAllowBuilds = document.has('allowBuilds');
+    let updated = yaml;
+    if (hasAllowBuilds && missingBuilds.length > 0) {
+        for (const name of missingBuilds){
+            document.setIn([
+                'allowBuilds',
+                name
+            ], false);
+        }
+        updated = document.toString({
+            singleQuote: true
+        });
+    }
+    const allowBuilds = Object.fromEntries(missingBuilds.map((name)=>[
+            name,
+            false
+        ]));
     const added = [
-        ...Object.hasOwn(settings, 'injectWorkspacePackages') ? [] : [
+        ...document.has('injectWorkspacePackages') ? [] : [
             injectSettings
         ],
-        ...Object.hasOwn(settings, 'dedupeInjectedDeps') ? [] : [
+        ...document.has('dedupeInjectedDeps') ? [] : [
             dedupeSettings
+        ],
+        ...hasAllowBuilds ? [] : [
+            `# Install scripts of the packages the targets run, which they don't need\n${stringify({
+                allowBuilds
+            }, {
+                singleQuote: true
+            })}`
         ]
     ];
-    if (added.length === 0) {
+    if (updated === yaml && added.length === 0) {
         return;
     }
-    const separator = yaml === '' || yaml.endsWith('\n') ? '' : '\n';
-    tree.write('pnpm-workspace.yaml', `${yaml}${separator}${added.join('')}`);
+    const separator = updated === '' || updated.endsWith('\n') ? '' : '\n';
+    tree.write('pnpm-workspace.yaml', `${updated}${separator}${added.join('')}`);
 };
 const initGenerator = async (tree, options = {})=>{
     const { lifecycle = true, skill = true } = options;
@@ -125,7 +178,11 @@ const initGenerator = async (tree, options = {})=>{
     if (existing === undefined) {
         plugins.push({
             plugin: pluginName,
-            options: {}
+            options: {
+                checkPackage: {
+                    profile: 'esm-only'
+                }
+            }
         });
     }
     const pluginOptions = typeof existing === 'object' ? existing.options ?? {} : {};
@@ -145,7 +202,8 @@ const initGenerator = async (tree, options = {})=>{
             plugin: lifecyclePlugin,
             options: {
                 stages: lifecycleStages,
-                bindings: Object.fromEntries(bindings)
+                bindings: Object.fromEntries(bindings),
+                warnUnusedBindings: false
             }
         });
     }
@@ -178,7 +236,14 @@ const initGenerator = async (tree, options = {})=>{
             ]
         });
     }
-    injectWorkspacePackages(tree);
+    if (!tree.exists('tsconfig.json')) {
+        writeJson(tree, 'tsconfig.json', {
+            files: [],
+            references: []
+        });
+    }
+    configurePnpm(tree);
+    ignoreOutputs(tree);
     const skillPath = '.claude/skills/principles/SKILL.md';
     if (skill && !tree.exists(skillPath)) {
         tree.write(skillPath, principlesSkill);

package/dist/lib/versions.d.ts

@@ -30,7 +30,8 @@ export interface WorkspaceVersions {
 export declare const readWorkspaceVersions: (tree: Tree) => Promise<WorkspaceVersions>;
 /**
  * The range to depend on a package by: `workspace:^` for one of the workspace's own, else `catalog:` from the default
- * catalog, else a range another workspace package uses, else the version this plugin was published with.
+ * catalog, else a range a workspace package uses, else, for one of Nx's own plugins (`@nx/*`), the range of `nx`,
+ * else the version this plugin was published with.
  *
  * @param name - the package
  * @param versions - from {@link readWorkspaceVersions}

package/dist/lib/versions.js

@@ -13,13 +13,15 @@ const ownVersions = async ()=>{
 export const readWorkspaceVersions = async (tree)=>{
     const packages = new Set();
     const ranges = new Map();
-    for (const { root } of getProjects(tree).values()){
+    const roots = new Set(getProjects(tree).values().map(({ root })=>root));
+    roots.add('.');
+    for (const root of roots){
         const path = joinPathFragments(root, 'package.json');
         if (!tree.exists(path)) {
             continue;
         }
         const packageJson = readJson(tree, path);
-        if (packageJson.name !== undefined) {
+        if (root !== '.' && packageJson.name !== undefined) {
             packages.add(packageJson.name);
         }
         const entries = [
@@ -29,7 +31,7 @@ export const readWorkspaceVersions = async (tree)=>{
             packageJson.peerDependencies
         ].flatMap((field)=>field === undefined ? [] : Object.entries(field));
         for (const [name, range] of entries){
-            if (!ranges.has(name) && !range.startsWith('workspace:')) {
+            if (!ranges.has(name) && !isProtocol(range)) {
                 ranges.set(name, range);
             }
         }
@@ -55,7 +57,7 @@ export const resolveVersion = (name, versions)=>{
     if (versions.catalogs.default?.[name] !== undefined) {
         return 'catalog:';
     }
-    const range = versions.ranges.get(name) ?? versions.fallback[name];
+    const range = versions.ranges.get(name) ?? (name.startsWith('@nx/') ? versions.ranges.get('nx') ?? versions.catalogs.default?.nx : undefined) ?? versions.fallback[name];
     if (range === undefined) {
         throw new Error(`No version of ${name} in the workspace: add it to the pnpm catalog or to a package first`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leyman/nx-plugin",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Nx plugin inferring the build, test, lint and package-check targets of TypeScript ESM packages: SWC and tsc builds, Mocha or Vitest under c8, ESLint, Biome and check-package.",
   "engines": {
     "node": ">=22.13.0"
@@ -68,7 +68,7 @@
     "@biomejs/biome": "^2.6.4",
     "@leyman/check-package": "^0.1.0",
     "@leyman/configs": "^0.1.0",
-    "@leyman/eslint-config": "^0.1.0",
+    "@leyman/eslint-config": "^0.1.1",
     "@leyman/expect": "^0.1.0",
     "@nx/js": "^23.3.1",
     "@swc/cli": "^0.8.1",
@@ -82,7 +82,7 @@
     "mocha": "^12.0.3",
     "mocha-chain": "^1.1.0",
     "nx": "^23.3.1",
-    "nx-lifecycle": "^1.2.2",
+    "nx-lifecycle": "^1.3.0",
     "typescript": "npm:@typescript/typescript6@^6.0.2",
     "vitest": "^5.0.3"
   }