feat: add generators internal options

src/generators/application/generator.ts

@@ -12,16 +12,16 @@ import { initGenerator } from '../init/generator';
 
 export async function applicationGenerator(
   tree: Tree,
-  options: ApplicationGeneratorSchema,
+  schema: ApplicationGeneratorSchema
 ) {
-  await initGenerator(tree);
+  await initGenerator(tree, schema);
 
-  let projectName = options.name;
-  let projectRoot = options.directory;
+  let projectName = schema.name;
+  let projectRoot = schema.directory;
 
   const nameAndRoot = await determineProjectNameAndRootOptions(tree, {
-    ...options,
-    projectNameAndRootFormat: options.projectNameAndRootFormat,
+    ...schema,
+    projectNameAndRootFormat: schema.projectNameAndRootFormat,
     projectType: 'application',
     callingGenerator: 'nx-foundry:application',
   });
@@ -37,7 +37,7 @@ export async function applicationGenerator(
   });
 
   generateFiles(tree, path.join(__dirname, 'files'), projectRoot, {
-    ...options,
+    ...schema,
     root: projectRoot,
   });
 

src/generators/application/schema.d.ts

@@ -4,4 +4,7 @@ export interface ApplicationGeneratorSchema {
   name: string;
   projectNameAndRootFormat?: ProjectNameAndRootFormat;
   directory?: string;
+  skipPackageJson?: boolean;
+  skipFormat?: boolean;
+  keepExistingVersions?: boolean;
 }

src/generators/application/schema.json

@@ -12,7 +12,26 @@
         "index": 0
       },
       "x-prompt": "What name would you like to use?"
+    },
+    "skipFormat": {
+      "description": "Skip formatting files",
+      "type": "boolean",
+      "default": false
+    },
+    "skipPackageJson": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not add dependencies to `package.json`.",
+      "x-priority": "internal"
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
     }
   },
-  "required": ["name"]
+  "required": [
+    "name"
+  ]
 }

src/generators/init/generator.spec.ts

@@ -36,12 +36,12 @@ jobs:
         with:
           version: 8
 
-`,
+`
     );
   });
 
   it('should add plugin to nx.json', async () => {
-    await initGenerator(tree);
+    await initGenerator(tree, {});
     const nxJson = readNxJson(tree);
 
     expect(nxJson.plugins).toMatchObject([
@@ -59,16 +59,16 @@ jobs:
   });
 
   it('should add .gitignore entry', async () => {
-    await initGenerator(tree);
+    await initGenerator(tree, {});
     const gitIgnore = tree.read('.gitignore', 'utf-8');
 
     expect(gitIgnore.includes('# Foundry')).toBe(true);
   });
 
   it('should add github actions step', async () => {
-    await initGenerator(tree);
+    await initGenerator(tree, {});
     expect(tree.read('.github/workflows/ci.yml', 'utf8')).toContain(
-      'Install Foundry',
+      'Install Foundry'
     );
   });
 });

src/generators/init/generator.ts

@@ -1,11 +1,37 @@
-import { formatFiles, readNxJson, Tree, updateNxJson } from '@nx/devkit';
-import { addGithubActionCI, addGitIgnoreEntry } from '../../utils';
+import {
+  addDependenciesToPackageJson,
+  formatFiles,
+  readNxJson,
+  removeDependenciesFromPackageJson,
+  Tree,
+  updateNxJson,
+} from '@nx/devkit';
+import {
+  addGithubActionCI,
+  addGitIgnoreEntry,
+  nxFoundryVersion,
+} from '../../utils';
+import { InitGeneratorSchema } from './schema';
 
-export async function initGenerator(tree: Tree) {
+const updateDependencies = (tree: Tree, schema: InitGeneratorSchema) => {
+  removeDependenciesFromPackageJson(tree, ['nx-foundry'], []);
+
+  return addDependenciesToPackageJson(
+    tree,
+    {},
+    {
+      'nx-foundry': nxFoundryVersion,
+    },
+    undefined,
+    schema.keepExistingVersions
+  );
+};
+
+const setupTargets = (tree: Tree) => {
   const nxJson = readNxJson(tree) || {};
 
   const hasPlugin = nxJson.plugins?.some((p) =>
-    typeof p === 'string' ? p === 'nx-foundry' : p.plugin === 'nx-foundry',
+    typeof p === 'string' ? p === 'nx-foundry' : p.plugin === 'nx-foundry'
   );
 
   if (!hasPlugin) {
@@ -29,11 +55,21 @@ export async function initGenerator(tree: Tree) {
   }
 
   updateNxJson(tree, nxJson);
+};
+
+export async function initGenerator(tree: Tree, schema: InitGeneratorSchema) {
+  setupTargets(tree);
 
   addGitIgnoreEntry(tree);
   addGithubActionCI(tree);
 
-  await formatFiles(tree);
+  if (!schema.skipFormat) {
+    await formatFiles(tree);
+  }
+
+  return !schema.skipPackageJson
+    ? updateDependencies(tree, schema)
+    : () => null;
 }
 
 export default initGenerator;

src/generators/init/schema.d.ts

@@ -0,0 +1,5 @@
+export interface InitGeneratorSchema {
+  skipPackageJson?: boolean;
+  skipFormat?: boolean;
+  keepExistingVersions?: boolean;
+}

src/generators/init/schema.json

@@ -3,6 +3,23 @@
   "$id": "Init",
   "title": "",
   "type": "object",
-  "properties": {},
-  "required": []
+  "properties": {
+    "skipFormat": {
+      "description": "Skip formatting files",
+      "type": "boolean",
+      "default": false
+    },
+    "skipPackageJson": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not add dependencies to `package.json`.",
+      "x-priority": "internal"
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
+    }
+  }
 }

src/utils/index.ts

@@ -1,2 +1,3 @@
 export * from './add-github-action-ci';
 export * from './add-gitignore-entry';
+export * from './versions';

src/utils/versions.ts

@@ -0,0 +1,3 @@
+import { version } from '../../package.json';
+
+export const nxFoundryVersion = version;

tsconfig.json

@@ -20,7 +20,8 @@
       "nx-foundry": [
         "src/index.ts"
       ]
-    }
+    },
+    "resolveJsonModule": true
   },
   "files": [],
   "include": [],