feat(plugin): add soba generator

Author: nartc

libs/plugin/generators.json

@@ -5,13 +5,23 @@
 			"factory": "./src/generators/init/generator",
 			"schema": "./src/generators/init/schema.json",
 			"description": "Init Angular Three with proper packages and config"
+		},
+		"add-soba": {
+			"factory": "./src/generators/add-soba/generator",
+			"schema": "./src/generators/add-soba/schema.json",
+			"description": "Add angular-three-soba to your project"
 		}
 	},
 	"schematics": {
 		"ng-add": {
 			"factory": "./src/generators/init/compat",
 			"schema": "./src/generators/init/schema.json",
 			"description": "Add Angular Three with proper packages and config"
-		}
+		},
+    "add-soba": {
+      "factory": "./src/generators/add-soba/compat",
+      "schema": "./src/generators/add-soba/schema.json",
+      "description": "Add angular-three-soba to your project"
+    }
 	}
 }

libs/plugin/package.json

@@ -1,4 +1,7 @@
 {
 	"name": "plugin",
-	"type": "commonjs"
+	"type": "commonjs",
+	"dependencies": {
+		"@nx/devkit": "19.5.6"
+	}
 }

libs/plugin/src/generators/add-soba/compat.ts

@@ -0,0 +1,4 @@
+import { convertNxGenerator } from '@nx/devkit';
+import addSoba from './generator';
+
+export default convertNxGenerator(addSoba);

libs/plugin/src/generators/add-soba/generator.spec.ts

@@ -0,0 +1,16 @@
+import { Tree } from '@nx/devkit';
+import { createTreeWithEmptyWorkspace } from '@nx/devkit/testing';
+import { initGenerator } from '../init/generator';
+
+describe('add-soba generator', () => {
+	let tree: Tree;
+
+	beforeEach(() => {
+		tree = createTreeWithEmptyWorkspace();
+	});
+
+	it('should run successfully', async () => {
+		await initGenerator(tree, { skipGenerateExperience: true });
+		expect(true).toBe(true);
+	});
+});

libs/plugin/src/generators/add-soba/generator.ts

@@ -0,0 +1,85 @@
+import { addDependenciesToPackageJson, formatFiles, installPackagesTask, logger, readJson, Tree } from '@nx/devkit';
+import { prompt } from 'enquirer';
+import { addMetadataJson } from '../utils';
+import { SOBA_PEER_DEPENDENCIES } from '../version';
+
+const ENTRY_POINTS = {
+	abstractions: ['troika-three-text'],
+	controls: ['camera-controls', 'maath'],
+	materials: ['three-custom-shader-material', 'three-mesh-bvh'],
+	staging: ['troika-three-text', '@monogrid/gainmap-js'],
+	stats: ['stats-gl'],
+};
+
+export async function addSobaGenerator(tree: Tree) {
+	const packagesToAdd = ['three-stdlib', '@pmndrs/vanilla'];
+
+	const packageJson = readJson(tree, 'package.json');
+	const ngtVersion = packageJson['dependencies']['angular-three'] || packageJson['devDependencies']['angular-three'];
+
+	if (!ngtVersion) {
+		logger.error('angular-three is not installed.');
+		return;
+	}
+
+	logger.info('Adding angular-three-soba...');
+	addMetadataJson(tree, 'angular-three-soba/metadata.json');
+
+	const { peerDependencies } = await prompt<{ peerDependencies: string[][] }>({
+		type: 'multiselect',
+		name: 'peerDependencies',
+		message: `To know which peer dependencies we need to add, please select the secondary entry points you are planning to use:`,
+		choices: [
+			...Object.entries(ENTRY_POINTS).map(([entryPoint, deps]) => ({
+				value: deps,
+				name: `angular-three-soba/${entryPoint}`,
+				message: entryPoint,
+			})),
+			{
+				value: [
+					'troika-three-text',
+					'three-custom-shader-material',
+					'three-mesh-bvh',
+					'@monogrid/gainmap-js',
+					'camera-controls',
+					'maath',
+					'stats-gl',
+				],
+				name: 'All',
+				message: 'I am not sure. Let me add all the peer dependencies.',
+			},
+		],
+	});
+
+	// flatten, dedupe peerDependencies, add to packagesToAdd
+	peerDependencies
+		.flat()
+		.filter((item, index, array) => array.indexOf(item) === index)
+		.forEach((item) => {
+			if (!packagesToAdd.includes(item)) {
+				packagesToAdd.push(item);
+			}
+		});
+
+	const depsToAdd = packagesToAdd.reduce(
+		(acc, item) => {
+			if (SOBA_PEER_DEPENDENCIES[item]) {
+				acc[item] = SOBA_PEER_DEPENDENCIES[item];
+			}
+			return acc;
+		},
+		{} as Record<string, string>,
+	);
+
+	// add deps to package.json
+	logger.info('Adding dependencies to package.json...');
+	addDependenciesToPackageJson(tree, depsToAdd, {});
+
+	await formatFiles(tree);
+
+	return () => {
+		installPackagesTask(tree);
+	};
+}
+
+export default addSobaGenerator;

libs/plugin/src/generators/add-soba/schema.json

@@ -0,0 +1,5 @@
+{
+	"$schema": "https://json-schema.org/schema",
+	"$id": "AddSoba",
+	"title": "Add Soba"
+}

libs/plugin/src/generators/version.ts

@@ -2,3 +2,16 @@ export const ANGULAR_THREE_VERSION = '^2.0.0';
 export const THREE_VERSION = '^0.166.0';
 export const THREE_TYPE_VERSION = '^0.166.0';
 export const NGXTENSION_VERSION = '^4.0.0';
+
+export const SOBA_PEER_DEPENDENCIES = {
+	'three-stdlib': '^2.0.0',
+	'@pmndrs/vanilla': '^1.19.0',
+	'camera-controls': '^2.8.0',
+	'hls.js': '^1.5.0',
+	maath: '^0.10.0',
+	meshline: '^3.1.0',
+	'stats-gl': '^2.0.0',
+	'three-custom-shader-material': '^5.4.0',
+	'three-mesh-bvh': '^0.7.0',
+	'troika-three-text': '^0.49.0',
+} as const;