design-angular-kit 1.2.1 → 1.3.0

package/schematics/ng-add/rules/setup-project/add-design-angular-kit.ts

@@ -1,40 +0,0 @@
-import { Rule, SchematicContext, Tree, callRule } from '@angular-devkit/schematics';
-import { isStandaloneApp } from '@angular/cdk/schematics';
-import { addRootImport, addRootProvider, readWorkspace } from '@schematics/angular/utility';
-import { getMainFilePath } from '@schematics/angular/utility/standalone/util';
-import { firstValueFrom, map } from 'rxjs';
-import { Schema } from '../../schema';
-import { NoMainFileException, NoProjectException } from './exceptions';
-
-export function addDesignAngularKit(options: Schema): Rule {
-  return async (host: Tree, context: SchematicContext) => {
-    const workspace = await readWorkspace(host);
-    const projectName = options.project || (workspace.extensions.defaultProject as string);
-
-    // 1. getting project by name
-    const project = workspace.projects.get(projectName);
-    if (!project) {
-      throw new NoProjectException(projectName);
-    }
-
-    // 2. getting main file for project
-    const mainFilePath = await getMainFilePath(host, projectName);
-    if (!mainFilePath || !host.read(mainFilePath)) {
-      throw new NoMainFileException(projectName);
-    }
-
-    const isNotStandaloneApp = !isStandaloneApp(host, mainFilePath);
-
-    const rule = isNotStandaloneApp
-      ? addRootImport(projectName, ({ code, external }) => code`${external('DesignAngularKitModule', 'design-angular-kit')}.forRoot()\n`)
-      : addRootProvider(projectName, ({ code, external }) => code`${external('provideDesignAngularKit', 'design-angular-kit')}()`);
-
-    return firstValueFrom(
-      callRule(rule, host, context).pipe(
-        map(() => {
-          return (): Rule => () => {};
-        })
-      )
-    );
-  };
-}

package/schematics/ng-add/rules/setup-project/add-http-client.ts

@@ -1,7 +0,0 @@
-import { Rule, SchematicContext, Tree, callRule, noop } from '@angular-devkit/schematics';
-
-export function addHttpClient(): Rule {
-  //this dependency should be provided at application level instead of lib level. ref: provideDesignAngularKit
-  //provideHttpClient(),
-  return (host: Tree, context: SchematicContext) => callRule(noop(), host, context);
-}

package/schematics/ng-add/rules/setup-project/add-import-to-style-file.ts

@@ -1,120 +0,0 @@
-import { JsonArray, JsonObject, normalize, workspaces } from '@angular-devkit/core';
-import { Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
-
-import { readWorkspace, writeWorkspace } from '@schematics/angular/utility';
-import * as path from 'path';
-
-import { Schema } from '../../schema';
-import { getProjectTargetOptions } from './angular-json-helper';
-import { NoProjectException } from './exceptions';
-
-const BOOTSTRAP_ITALIA_CSS_FILEPATH = 'node_modules/bootstrap-italia/dist/css/bootstrap-italia.min.css';
-const SUPPORTED_BOOTSTRAP_ITALIA_STYLE_MAP: Record<string, string> = {
-  '.sass': `
-  /* Importazione libreria SCSS di bootstrap-italia */
-  @import 'bootstrap-italia/scss/bootstrap-italia'
-  `,
-  '.scss': `
-  /* Importazione libreria SCSS di bootstrap-italia */
-  @import '../node_modules/bootstrap-italia/src/scss/bootstrap-italia.scss';
-  `,
-};
-
-/**
- * if supported
- *    add to styles.scss or to style.sass
- * else
- *  add css to assets in angular.json
- * @param options
- * @returns Rule
- */
-export function addImportToStyleFile(options: Schema): Rule {
-  return async (host: Tree, context: SchematicContext) => {
-    const workspace = await readWorkspace(host);
-
-    const projectName = options.project || workspace.extensions.defaultProject!.toString();
-    const project = workspace.projects.get(projectName);
-    if (!project) {
-      throw new NoProjectException(projectName);
-    }
-
-    const styleFilePath = getProjectStyleFile(project as any) || '';
-    const styleFileExtension = path.extname(styleFilePath);
-    const styleFilePatch = SUPPORTED_BOOTSTRAP_ITALIA_STYLE_MAP[styleFileExtension];
-
-    // found supported styles
-    if (styleFilePatch) {
-      return addBootstrapItaliaToStylesFile(styleFilePath, styleFilePatch);
-    } else {
-      // found some styles, but unsupported
-      if (styleFileExtension !== '.css' && styleFileExtension !== '') {
-        context.logger.warn('messages.unsupportedStyles(styleFilePath)');
-      }
-
-      // just patching 'angular.json'
-      addBootstrapItaliaToAngularJson(project as any);
-      await writeWorkspace(host, workspace);
-    }
-  };
-}
-
-function addBootstrapItaliaToStylesFile(styleFilePath: string, styleFilePatch: string): Rule {
-  return async (host: Tree) => {
-    const styleContent = host.read(styleFilePath)!.toString('utf-8');
-
-    const recorder = host.beginUpdate(styleFilePath);
-    recorder.insertRight(styleContent.length, styleFilePatch);
-
-    host.commitUpdate(recorder);
-  };
-}
-
-function addBootstrapItaliaToAngularJson(project: workspaces.ProjectDefinition) {
-  const targetOptions = getProjectTargetOptions(project, 'build');
-  const styles = targetOptions.styles as JsonArray | undefined;
-  if (!styles) {
-    targetOptions.styles = [BOOTSTRAP_ITALIA_CSS_FILEPATH];
-  } else {
-    const existingStyles = styles.map(s => (typeof s === 'string' ? s : (s as JsonObject)!['input'])) as Array<string>;
-
-    for (const [, stylePath] of existingStyles.entries()) {
-      if (stylePath === BOOTSTRAP_ITALIA_CSS_FILEPATH) {
-        return;
-      }
-    }
-    styles.unshift(BOOTSTRAP_ITALIA_CSS_FILEPATH);
-  }
-}
-
-// Regular expression that matches all possible Angular CLI default style files
-const defaultStyleFileRegex = /styles\.(c|le|sc|sa)ss/;
-
-// Regular expression that matches all files that have a proper stylesheet extension
-const validStyleFileRegex = /\.(c|le|sc|sa)ss/;
-
-function getProjectStyleFile(project: workspaces.ProjectDefinition, extension?: string): string | null {
-  const buildOptions = getProjectTargetOptions(project, 'build');
-
-  if (buildOptions.styles && Array.isArray(buildOptions.styles) && buildOptions.styles.length) {
-    const styles = buildOptions.styles.map(s => (typeof s === 'string' ? s : (s as JsonObject)!['input'])) as Array<string>;
-
-    // Look for the default style file that is generated for new projects by the Angular CLI. This
-    // default style file is usually called `styles.ext` unless it has been changed explicitly.
-    const defaultMainStylePath = styles.find(file => (extension ? file === `styles.${extension}` : defaultStyleFileRegex.test(file)));
-
-    if (defaultMainStylePath) {
-      return normalize(defaultMainStylePath);
-    }
-
-    // If no default style file could be found, use the first style file that matches the given
-    // extension. If no extension specified explicitly, we look for any file with a valid style
-    // file extension.
-    const fallbackStylePath = styles.find(file => (extension ? file.endsWith(`.${extension}`) : validStyleFileRegex.test(file)));
-
-    if (fallbackStylePath) {
-      return normalize(fallbackStylePath);
-    }
-  }
-
-  return null;
-}

package/schematics/ng-add/rules/setup-project/add-localisation.ts

@@ -1,45 +0,0 @@
-import { JsonArray, JsonObject, workspaces } from '@angular-devkit/core';
-import { Rule, Tree } from '@angular-devkit/schematics';
-import { readWorkspace, writeWorkspace } from '@schematics/angular/utility';
-
-import { Schema } from '../../schema';
-import { getProjectTargetOptions } from './angular-json-helper';
-import { NoProjectException } from './exceptions';
-
-const LOCALISATION_CONFIG = {
-  glob: '**/*',
-  input: './node_modules/design-angular-kit/assets/i18n',
-  output: '/bootstrap-italia/i18n/',
-};
-
-export function addLocalisation(options: Schema): Rule {
-  return async (host: Tree) => {
-    const workspace = await readWorkspace(host);
-
-    const projectName = options.project || workspace.extensions.defaultProject!.toString();
-    const project = workspace.projects.get(projectName);
-    if (!project) {
-      throw new NoProjectException(projectName);
-    }
-
-    addLocalisationToAngularJson(project);
-    await writeWorkspace(host, workspace);
-  };
-}
-
-function addLocalisationToAngularJson(project: workspaces.ProjectDefinition) {
-  const targetOptions = getProjectTargetOptions(project, 'build');
-  const assets = targetOptions.assets as JsonArray | undefined;
-  if (!assets) {
-    targetOptions.assets = [LOCALISATION_CONFIG];
-  } else {
-    const existingAssets = assets.map(s => (typeof s === 'string' ? s : (s as JsonObject)!['input'])) as Array<string>;
-
-    for (const [, input] of existingAssets.entries()) {
-      if (input === LOCALISATION_CONFIG.input) {
-        return;
-      }
-    }
-    assets.push(LOCALISATION_CONFIG);
-  }
-}

package/schematics/ng-add/rules/setup-project/angular-json-helper.ts

@@ -1,11 +0,0 @@
-import { workspaces } from '@angular-devkit/core';
-import { SchematicsException } from '@angular-devkit/schematics';
-
-export function getProjectTargetOptions(project: workspaces.ProjectDefinition, buildTarget: string) {
-  const buildTargetObject = project.targets.get(buildTarget);
-  if (buildTargetObject && buildTargetObject.options) {
-    return buildTargetObject.options;
-  }
-
-  throw new SchematicsException(`Cannot determine project target configuration for: ${buildTarget}.`);
-}

package/schematics/ng-add/rules/setup-project/exceptions.ts

@@ -1,13 +0,0 @@
-import { SchematicsException } from '@angular-devkit/schematics';
-
-export class NoProjectException extends SchematicsException {
-  constructor(project: string) {
-    super(`Unable to find project '${project}' in the workspace`);
-  }
-}
-
-export class NoMainFileException extends SchematicsException {
-  constructor(project: string) {
-    super(`Unable to find 'build.options.main' file path for project "${project}`);
-  }
-}

package/schematics/ng-add/setup-project.spec.ts

@@ -1,166 +0,0 @@
-import { SchematicTestRunner } from '@angular-devkit/schematics/testing';
-import * as path from 'path';
-import { Schema } from './schema';
-
-const createApp = async (
-  runner: SchematicTestRunner,
-  options: Schema,
-  { standalone, style }: { standalone: boolean; style: 'scss' | 'css' | 'sass' }
-) => {
-  let tree = await runner.runExternalSchematic('@schematics/angular', 'workspace', {
-    name: 'workspace',
-    version: '18.0.0',
-    newProjectRoot: 'projects',
-  });
-
-  tree = await runner.runExternalSchematic(
-    '@schematics/angular',
-    'application',
-    {
-      name: options.project,
-      standalone,
-      style,
-    },
-    tree
-  );
-
-  return { tree };
-};
-
-describe(`ng add design-angular-kit | setup-project - library providing`, () => {
-  const collectionPath = path.join(__dirname, '../collection.json');
-  const runner = new SchematicTestRunner('schematics', collectionPath);
-
-  const defaultOptions: Schema = {
-    project: 'test-project', // Set your default project name
-  };
-
-  it('should add DesignAngularKitModule to the root module - NgModule app', async () => {
-    const { tree: appTree } = await createApp(runner, defaultOptions, { standalone: false, style: 'scss' });
-    const tree = await runner.runSchematic('ng-add-setup-project', defaultOptions, appTree);
-
-    // Check if the app.module.ts file exists
-    const modulePath = '/projects/test-project/src/app/app.module.ts';
-    expect(tree.files).toContain(modulePath);
-
-    // Check if the correct import statement was added
-    const content = tree.readContent(modulePath);
-    expect(content).toContain(`import { DesignAngularKitModule } from 'design-angular-kit';`);
-    expect(content).toContain(`DesignAngularKitModule.forRoot()`);
-  });
-
-  it('should add provideDesignAngularKit() to the app config - Standalone app', async () => {
-    const { tree: appTree } = await createApp(runner, defaultOptions, { standalone: true, style: 'scss' });
-    const tree = await runner.runSchematic('ng-add-setup-project', defaultOptions, appTree);
-
-    // Check if the app.module.ts file exists
-    const appConfigPath = '/projects/test-project/src/app/app.config.ts';
-    expect(tree.files).toContain(appConfigPath);
-
-    // Check if the correct import statement was added
-    const content = tree.readContent(appConfigPath);
-    expect(content).toContain(`import { provideDesignAngularKit } from 'design-angular-kit';`);
-    expect(content).toContain(`provideDesignAngularKit()`);
-  });
-});
-
-for (const standalone of [true, false]) {
-  describe(`ng add design-angular-kit | setup-project for ${standalone ? 'standalone' : 'NgModule'} app - styles`, () => {
-    const collectionPath = path.join(__dirname, '../collection.json');
-    const runner = new SchematicTestRunner('schematics', collectionPath);
-
-    const defaultOptions: Schema = {
-      project: 'test-project', // Set your default project name
-    };
-
-    it('should add .scss import to project style file', async () => {
-      const { tree: appTree } = await createApp(runner, defaultOptions, { standalone, style: 'scss' });
-      const tree = await runner.runSchematic('ng-add-setup-project', defaultOptions, appTree);
-
-      // Check if the styles.scss file exists
-      const styleFilePath = '/projects/test-project/src/styles.scss';
-      expect(tree.files).toContain(styleFilePath);
-      // Check if the correct import statement was added
-      const content = tree.readContent(styleFilePath);
-      expect(content).toContain(`@import '../node_modules/bootstrap-italia/src/scss/bootstrap-italia.scss';`);
-    });
-
-    it('should add .sass import to project style file', async () => {
-      const { tree: appTree } = await createApp(runner, defaultOptions, { standalone, style: 'sass' });
-      const tree = await runner.runSchematic('ng-add-setup-project', defaultOptions, appTree);
-
-      // Check if the styles.sass file exists
-      const styleFilePath = '/projects/test-project/src/styles.sass';
-      expect(tree.files).toContain(styleFilePath);
-      // Check if the correct import statement was added
-      const content = tree.readContent(styleFilePath);
-      expect(content).toContain(`@import 'bootstrap-italia/scss/bootstrap-italia'`);
-    });
-
-    it('should add .css import to angular.json', async () => {
-      const { tree: appTree } = await createApp(runner, defaultOptions, { standalone, style: 'css' });
-      const tree = await runner.runSchematic('ng-add-setup-project', defaultOptions, appTree);
-
-      // Check if the angular.json file exists
-      const angularJsonPath = '/angular.json';
-      expect(tree.files).toContain(angularJsonPath);
-      // Check if the correct import statement was added
-      const content = tree.readContent(angularJsonPath);
-      expect(content).toContain(`node_modules/bootstrap-italia/dist/css/bootstrap-italia.min.css`);
-    });
-  });
-
-  describe(`ng add design-angular-kit | setup-project for ${standalone ? 'standalone' : 'NgModule'} app - assets`, () => {
-    const collectionPath = path.join(__dirname, '../collection.json');
-    const runner = new SchematicTestRunner('schematics', collectionPath);
-
-    const defaultOptions: Schema = {
-      project: 'test-project', // Set your default project name
-    };
-
-    it('should add bootstrap italia assets to angular.json', async () => {
-      const { tree: appTree } = await createApp(runner, defaultOptions, { standalone, style: 'css' });
-      const tree = await runner.runSchematic('ng-add-setup-project', defaultOptions, appTree);
-
-      // Check if the angular.json file exists
-      const angularJsonPath = '/angular.json';
-      expect(tree.files).toContain(angularJsonPath);
-      // Check if the correct import statement was added
-      const content = tree.readContent(angularJsonPath);
-      //"./node_modules/bootstrap-italia/"
-      expect(content).toContain(`./node_modules/bootstrap-italia/`);
-      const angularJson = JSON.parse(content);
-      const assetsConfig = angularJson.projects[defaultOptions.project]?.architect?.build?.options?.assets?.find(
-        (item: { input: string }) => item.input === `./node_modules/bootstrap-italia/`
-      );
-      expect(assetsConfig).toBeDefined(assetsConfig);
-    });
-  });
-
-  describe(`ng add design-angular-kit | setup-project for ${standalone ? 'standalone' : 'NgModule'} app - localisation`, () => {
-    const collectionPath = path.join(__dirname, '../collection.json');
-    const runner = new SchematicTestRunner('schematics', collectionPath);
-
-    const defaultOptions: Schema = {
-      project: 'test-project', // Set your default project name
-    };
-
-    it('should add bootstrap italia localisation to angular.json', async () => {
-      const { tree: appTree } = await createApp(runner, defaultOptions, { standalone, style: 'css' });
-      const tree = await runner.runSchematic('ng-add-setup-project', defaultOptions, appTree);
-
-      // Check if the angular.json file exists
-      const angularJsonPath = '/angular.json';
-      expect(tree.files).toContain(angularJsonPath);
-      // Check if the correct import statement was added
-      const content = tree.readContent(angularJsonPath);
-      //"./node_modules/bootstrap-italia/"
-      expect(content).toContain(`/node_modules/design-angular-kit/assets/i18n`);
-      const angularJson = JSON.parse(content);
-      const assetsConfig = angularJson.projects[defaultOptions.project]?.architect?.build?.options?.assets?.find(
-        (item: { input: string }) => item.input === `./node_modules/design-angular-kit/assets/i18n`
-      );
-      expect(assetsConfig).toBeDefined(assetsConfig);
-    });
-  });
-}

package/schematics/ng-add/setup-project.ts

@@ -1,31 +0,0 @@
-import { chain, Rule, SchematicContext, Tree } from '@angular-devkit/schematics';
-
-import { getProjectFromWorkspace } from '@angular/cdk/schematics';
-import { getWorkspace } from '@schematics/angular/utility/workspace';
-import { addAnimations, addAssets, addDesignAngularKit, addHttpClient, addImportToStyleFile, addLocalisation } from './rules/setup-project';
-import { Schema } from './schema';
-
-import { ProjectType } from '@schematics/angular/utility/workspace-models';
-
-export default function (options: Schema): Rule {
-  return async (host: Tree, context: SchematicContext) => {
-    const workspace = await getWorkspace(host);
-    const project = getProjectFromWorkspace(workspace, options.project);
-    const isAProject = project.extensions['projectType'] === ProjectType.Application;
-
-    if (isAProject) {
-      return chain([
-        addAnimations(),
-        addHttpClient(),
-        addDesignAngularKit(options),
-        addImportToStyleFile(options),
-        addAssets(options),
-        addLocalisation(options),
-      ]);
-    }
-    context.logger.warn(
-      `Design Angular Kit has been set in your workspace. No additional setup required.\nIf you intend to run the schematics on a specific project, please use -- project option `
-    );
-    return;
-  };
-}

package/schematics/ng-add/utils.ts

@@ -1,71 +0,0 @@
-import { Tree } from '@angular-devkit/schematics';
-
-interface PackageJson {
-  dependencies: Record<string, string>;
-}
-
-interface SemVerObject {
-  semVer?: string;
-  major?: string;
-  minor?: string;
-  patch?: string;
-  prerelease?: string;
-  buildmetadata?: string;
-}
-
-const SEMVER_WITH_PREFIX_REGEX =
-  /^[\^~]?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$/;
-
-function sortObjectByKeys(obj: Record<string, string>) {
-  return Object.keys(obj)
-    .sort()
-    .reduce(
-      (result, key) => {
-        result[key] = obj[key];
-        return result;
-      },
-      {} as Record<string, string>
-    );
-}
-
-/** Get a SemVerObject given a semver string */
-export function toSemVerObject(versionString: string) {
-  const [semVer, major, minor, patch, prerelease, buildmetadata] = versionString.match(SEMVER_WITH_PREFIX_REGEX) ?? [];
-  return { semVer, major, minor, patch, prerelease, buildmetadata } satisfies SemVerObject;
-}
-
-/** Adds a package to the package.json in the given host tree. */
-export function addPackageToPackageJson(host: Tree, pkg: string, version: string): Tree {
-  if (host.exists('package.json')) {
-    const sourceText = host.read('package.json')!.toString('utf-8');
-    const json = JSON.parse(sourceText) as PackageJson;
-
-    if (!json.dependencies) {
-      json.dependencies = {};
-    }
-
-    if (!json.dependencies[pkg]) {
-      json.dependencies[pkg] = version;
-      json.dependencies = sortObjectByKeys(json.dependencies);
-    }
-
-    host.overwrite('package.json', JSON.stringify(json, null, 2));
-  }
-
-  return host;
-}
-
-/** Gets the version of the specified package by looking at the package.json in the given tree. */
-export function getPackageVersionFromPackageJson(tree: Tree, name: string): string | null {
-  if (!tree.exists('package.json')) {
-    return null;
-  }
-
-  const packageJson = JSON.parse(tree.read('package.json')!.toString('utf8')) as PackageJson;
-
-  if (packageJson.dependencies && packageJson.dependencies[name]) {
-    return packageJson.dependencies[name];
-  }
-
-  return null;
-}

package/schematics/ng-add/versions-helper.ts

@@ -1,41 +0,0 @@
-const ANGULAR_VERSIONS = {
-  v17: '17',
-  v18: '18',
-};
-
-const KIT_VERSION_1_0_0 = '1.0.0';
-const KIT_VERSION_1_1_0 = '1.1.0';
-const DEFAULT = 'DEFAULT';
-const LATEST = 'LATEST';
-
-const versionsMap: Record<string, string> = {
-  [DEFAULT]: KIT_VERSION_1_0_0,
-  [ANGULAR_VERSIONS.v17]: KIT_VERSION_1_0_0,
-  [ANGULAR_VERSIONS.v18]: KIT_VERSION_1_1_0,
-  [LATEST]: KIT_VERSION_1_1_0,
-};
-
-// Get Design Angular Kit package version given Angular major version
-export function getPackageVersion({ angularMajorVersion }: { angularMajorVersion: string }) {
-  if (isNaN(+angularMajorVersion)) {
-    throw new Error('Major version is not a number');
-  }
-
-  let version = versionsMap[DEFAULT];
-
-  switch (angularMajorVersion) {
-    case ANGULAR_VERSIONS.v17:
-      version = versionsMap[ANGULAR_VERSIONS.v17];
-      break;
-    case ANGULAR_VERSIONS.v18:
-      version = versionsMap[ANGULAR_VERSIONS.v18];
-      break;
-    default: {
-      if (Number(angularMajorVersion) > Number(ANGULAR_VERSIONS.v18)) {
-        version = versionsMap[LATEST];
-      }
-    }
-  }
-
-  return version;
-}