refactor(transloco): 💡 Remove all the schematics but init

This is the first commit in a series for extracting the schematics to a
different lib and removing the commonjs dependecies from Transloco which
aren't really used

BREAKING CHANGE: 🧨 ng-add is the only available schematic in @jsverse/transloco now

✅ Closes: #768

Author: shaharkazaz

libs/transloco-schematics/src/collection.json

@@ -2,12 +2,6 @@
   "extends": ["@schematics/angular"],
   "$schema": "../../../node_modules/@angular-devkit/schematics/collection-schema.json",
   "schematics": {
-    "ng-add": {
-      "aliases": ["init"],
-      "factory": "./ng-add/index",
-      "schema": "./ng-add/schema.json",
-      "description": "Add transloco configuration for root module."
-    },
     "component": {
       "aliases": ["c"],
       "factory": "./component/index",

libs/transloco-schematics/src/ng-add/generators/translation-files.gen.ts

@@ -22,11 +22,12 @@ import { Change } from '@schematics/angular/utility/change';
 import { LIB_NAME } from '../schematics.utils';
 import { coerceArray, stringifyList } from '../utils/array';
 import { findModuleFromOptions } from '../utils/find-module';
-import { getProject, getProjectPath } from '../utils/projects';
+import { getProject } from '../utils/projects';
 import { createTranslateFilesFromOptions } from '../utils/translations';
 import { getConfig } from '../utils/config';
 
 import { SchemaOptions } from './schema';
+import { getProjectPath } from './utils';
 
 function getProviderValue(options: SchemaOptions) {
   const name = dasherize(options.name);

libs/transloco-schematics/src/scope/index.ts

@@ -0,0 +1,23 @@
+import { Tree } from '@angular-devkit/schematics';
+import { WorkspaceProject } from '@schematics/angular/utility/workspace-models';
+
+import { SchemaOptions } from './schema';
+
+export function getProjectPath(
+  host: Tree,
+  project: WorkspaceProject,
+  options: SchemaOptions,
+) {
+  if (project.root.at(-1) === '/') {
+    project.root = project.root.slice(0, project.root.length - 1);
+  }
+
+  if (options.path === undefined) {
+    const projectDirName =
+      project.projectType === 'application' ? 'app' : 'lib';
+
+    return `${project.root ? `/${project.root}` : ''}/src/${projectDirName}`;
+  }
+
+  return options.path;
+}

libs/transloco-schematics/src/scope/utils.ts

@@ -48,18 +48,3 @@ export function setEnvironments(
     host.overwrite(filePath, transformer(source));
   });
 }
-
-export function getProjectPath(host: Tree, project, options) {
-  if (project.root.substr(-1) === '/') {
-    project.root = project.root.substr(0, project.root.length - 1);
-  }
-
-  if (options.path === undefined) {
-    const projectDirName =
-      project.projectType === 'application' ? 'app' : 'lib';
-
-    return `${project.root ? `/${project.root}` : ''}/src/${projectDirName}`;
-  }
-
-  return options.path;
-}

libs/transloco-schematics/src/utils/projects.ts

@@ -0,0 +1,2 @@
+/src/**/*.js
+/src/**/*.js.map

libs/transloco-utils/.gitignore

@@ -1,17 +1,13 @@
 {
   "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
   "dest": "../../dist/libs/transloco",
-  "assets": ["README.md", "CHANGELOG.md"],
+  "assets": [
+    "README.md",
+    "CHANGELOG.md",
+    "schematics/**/*.json",
+    "**/files/**/*"
+  ],
   "lib": {
     "entryFile": "src/index.ts"
-  },
-  "allowedNonPeerDependencies": [
-    "fs-extra",
-    "glob",
-    "flat",
-    "@jsverse/transloco-utils",
-    "replace-in-file",
-    "lodash.kebabcase",
-    "ora"
-  ]
+  }
 }

libs/transloco/ng-package.json

@@ -15,25 +15,16 @@
     "url": "https://github.com/jsverse/transloco"
   },
   "keywords": [
-    "angular",
-    "angular 2",
+    "Angular",
     "i18n",
-    "translate",
-    "angular translate",
-    "angular i18n",
-    "transloco"
+    "Translate",
+    "Angular Translate",
+    "Transloco",
+    "Schematics",
+    "Angular CLI"
   ],
   "license": "MIT",
   "peerDependencies": {
     "@angular/core": ">=16.0.0"
-  },
-  "dependencies": {
-    "fs-extra": "^11.0.0",
-    "glob": "^10.0.0",
-    "tslib": "^2.2.0",
-    "@jsverse/transloco-utils": "^7.0.0",
-    "replace-in-file": "^7.0.1",
-    "ora": "^5.4.1",
-    "lodash.kebabcase": "^4.1.1"
   }
 }

libs/transloco/package.json

@@ -6,7 +6,7 @@
   "prefix": "transloco-nx-shell",
   "tags": [],
   "targets": {
-    "build": {
+    "build-package": {
       "dependsOn": ["copy-readme"],
       "executor": "@nx/angular:package",
       "outputs": ["{workspaceRoot}/dist/libs/transloco"],
@@ -23,6 +23,21 @@
       },
       "defaultConfiguration": "production"
     },
+    "build": {
+      "executor": "nx:run-commands",
+      "options": {
+        "parallel": false,
+        "commands": [
+          {
+            "command": "nx build-package transloco"
+          },
+          {
+            "command": "npx tsc -p libs/transloco/tsconfig.schematics.json"
+          }
+        ]
+      },
+      "outputs": ["{workspaceRoot}/dist/libs/transloco"]
+    },
     "test": {
       "executor": "@angular-devkit/build-angular:karma",
       "options": {

libs/transloco/project.json

@@ -0,0 +1,7 @@
+export { stringifyList, coerceArray } from './utils/collections';
+export { getProject, setEnvironments } from './utils/workspace';
+export { createTranslocoConfig } from './utils/transloco';
+export {
+  createTranslateFiles,
+  checkIfTranslationFilesExist,
+} from './utils/translation';

libs/transloco/schematics-core/index.ts

@@ -0,0 +1,65 @@
+import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
+import type { Schema as WorkspaceSchema } from '@schematics/angular/workspace/schema';
+import {
+  Style,
+  ViewEncapsulation,
+  Schema as ApplicationSchema,
+} from '@schematics/angular/application/schema';
+import type { Schema as LibrarySchema } from '@schematics/angular/library/schema';
+
+export const defaultWorkspaceOptions: WorkspaceSchema = {
+  name: 'workspace',
+  newProjectRoot: 'projects',
+  version: '16.0.4',
+  minimal: true,
+};
+
+export const defaultAppOptions: ApplicationSchema = {
+  name: 'bar',
+  inlineStyle: false,
+  inlineTemplate: false,
+  viewEncapsulation: ViewEncapsulation.Emulated,
+  routing: false,
+  style: Style.Css,
+  skipTests: false,
+};
+
+const defaultLibOptions = {
+  name: 'baz',
+};
+
+export function createWorkspace(
+  schematicRunner: SchematicTestRunner,
+  options: {
+    workspaceOptions?: Partial<WorkspaceSchema>;
+    appOptions?: Partial<ApplicationSchema>;
+    libOptions?: Partial<LibrarySchema>;
+  } = {},
+) {
+  const appOptions = { ...defaultAppOptions, ...options.appOptions };
+  const workspaceOptions = {
+    ...defaultWorkspaceOptions,
+    ...options.workspaceOptions,
+  };
+  const libOptions = { ...defaultLibOptions, ...options.libOptions };
+  const angularSchematic = '@schematics/angular';
+
+  return schematicRunner
+    .runExternalSchematic(angularSchematic, 'workspace', workspaceOptions)
+    .then((tree) =>
+      schematicRunner.runExternalSchematic(
+        angularSchematic,
+        'application',
+        appOptions,
+        tree,
+      ),
+    )
+    .then((tree) =>
+      schematicRunner.runExternalSchematic(
+        angularSchematic,
+        'library',
+        libOptions,
+        tree,
+      ),
+    );
+}

libs/transloco/schematics-core/testing/create-workspace.ts

@@ -0,0 +1 @@
+export * from './create-workspace';

libs/transloco/schematics-core/testing/index.ts

@@ -0,0 +1,9 @@
+export function stringifyList<T>(list: T[], separator = ', '): string {
+  return list.map((item) => `'${item}'`).join(separator);
+}
+
+export function coerceArray<T>(value: T | T[]): T[];
+export function coerceArray<T>(value: T | readonly T[]): readonly T[];
+export function coerceArray<T>(value: T | T[]): T[] {
+  return Array.isArray(value) ? value : [value];
+}

libs/transloco/schematics-core/utils/collections.ts

@@ -0,0 +1,29 @@
+import * as nodePath from 'node:path';
+
+import { PathFragment } from '@angular-devkit/core';
+import { DirEntry, Tree } from '@angular-devkit/schematics';
+
+export function getJsonFileContent(fileName: PathFragment, dir: DirEntry) {
+  const content = dir.file(fileName)!.content.toString('utf-8');
+  return JSON.parse(content);
+}
+
+export function writeToJson(
+  host: Tree,
+  dirPath: string,
+  fileName: PathFragment,
+  content: unknown,
+) {
+  return host.overwrite(
+    nodePath.join(dirPath, fileName),
+    JSON.stringify(content, null, 2),
+  );
+}
+
+export function hasSubdirs(dir: DirEntry): boolean {
+  return dir.subdirs && dir.subdirs.length > 0;
+}
+
+export function hasFiles(dir: DirEntry): boolean {
+  return dir.subfiles && dir.subfiles.length > 0;
+}