Scaffolded analyze-ember-project-dependencies

.changeset/old-spies-tease.md

@@ -0,0 +1,5 @@
+---
+"analyze-ember-project-dependencies": minor
+---
+
+Scaffolded analyze-ember-project-dependencies

packages/analyze-ember-project-dependencies/.eslintignore

@@ -0,0 +1,13 @@
+# compiled output
+/dist/
+/dist-for-testing/
+/tmp/
+
+# dependencies
+/node_modules/
+
+# misc
+!.*
+.*/
+/src/blueprints/
+/tests/fixtures/

packages/analyze-ember-project-dependencies/.eslintrc.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+require('@shared-configs/eslint-config-node/patch');
+
+module.exports = {
+  extends: ['@shared-configs/eslint-config-node/typescript'],
+  overrides: [
+    {
+      files: ['bin/**/*.{js,ts}'],
+      rules: {
+        'n/hashbang': 'off',
+      },
+    },
+  ],
+};

packages/analyze-ember-project-dependencies/.npmignore

@@ -0,0 +1,22 @@
+# compiled output
+/dist-for-testing/
+/tmp/
+
+# dependencies
+/node_modules/
+
+# misc
+/.DS_Store
+/.env*
+/.eslintcache
+/.eslintignore
+/.eslintrc.cjs
+/.git/
+/.github/
+/.gitignore
+/.pnpm-debug.log
+/.prettierignore
+/.prettierrc.cjs
+/build.sh
+/tests/
+/update-test-fixtures.sh

packages/analyze-ember-project-dependencies/.prettierrc.cjs

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports = require('@shared-configs/prettier');

packages/analyze-ember-project-dependencies/CHANGELOG.md

@@ -0,0 +1 @@
+# analyze-ember-project-dependencies

packages/analyze-ember-project-dependencies/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Isaac J. Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/analyze-ember-project-dependencies/README.md

@@ -0,0 +1,15 @@
+# analyze-ember-project-dependencies
+
+## Compatibility
+
+- Node.js v18 or above
+
+
+## Contributing
+
+See the [Contributing](../../CONTRIBUTING.md) guide for details.
+
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

packages/analyze-ember-project-dependencies/bin/analyze-ember-project-dependencies.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+'use strict';
+
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+
+import { analyzeEmberProjectDependencies } from '../src/index.js';
+import type { CodemodOptions } from '../src/types/index.js';
+
+// Provide a title to the process in `ps`
+process.title = 'analyze-ember-project-dependencies';
+
+// Set codemod options
+const argv = yargs(hideBin(process.argv))
+  .option('root', {
+    describe: 'Where to run the codemod',
+    type: 'string',
+  })
+  .parseSync();
+
+const codemodOptions: CodemodOptions = {
+  projectRoot: argv['root'] ?? process.cwd(),
+};
+
+analyzeEmberProjectDependencies(codemodOptions);

packages/analyze-ember-project-dependencies/build.sh

@@ -0,0 +1,40 @@
+#!/usr/bin/env sh
+
+COMMAND="analyze-ember-project-dependencies"
+ENVIRONMENT=$1
+
+if [ $ENVIRONMENT = "--production" ]
+then
+  # Clean slate
+  rm -rf "dist"
+
+  # Compile TypeScript
+  tsc --project "tsconfig.build.json"
+
+  # Configure files
+  chmod +x "dist/bin/$COMMAND.js"
+
+  if [ -d "src/blueprints" ]
+  then
+    cp -r "src/blueprints" "dist/src/blueprints"
+  fi
+
+  echo "SUCCESS: Built dist.\n"
+
+elif [ $ENVIRONMENT = "--test" ]
+then
+  # Clean slate
+  rm -rf "dist-for-testing"
+
+  # Compile TypeScript
+  tsc --project "tsconfig.json"
+
+  # Configure files
+  if [ -d "src/blueprints" ]
+  then
+    cp -r "src/blueprints" "dist-for-testing/src/blueprints"
+  fi
+
+  echo "SUCCESS: Built dist-for-testing.\n"
+
+fi

packages/analyze-ember-project-dependencies/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "analyze-ember-project-dependencies",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Analyze dependencies of an Ember project",
+  "keywords": [
+    "codemod",
+    "ember-codemod",
+    "emberjs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ijlee2/embroider-toolbox.git"
+  },
+  "license": "MIT",
+  "author": "Isaac J. Lee",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "bin": "dist/bin/analyze-ember-project-dependencies.js",
+  "directories": {
+    "test": "tests"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "./build.sh --production",
+    "lint": "concurrently 'pnpm:lint:*(!fix)' --names 'lint:'",
+    "lint:fix": "concurrently 'pnpm:lint:*:fix' --names 'fix:'",
+    "lint:js": "eslint . --cache",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "tsc --noEmit",
+    "test": "./build.sh --test && mt dist-for-testing --quiet"
+  },
+  "dependencies": {
+    "@codemod-utils/ast-javascript": "^1.2.8",
+    "@codemod-utils/ast-template": "^1.1.4",
+    "@codemod-utils/ember-cli-string": "^1.1.4",
+    "@codemod-utils/files": "^2.0.4",
+    "@codemod-utils/json": "^1.1.9",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@codemod-utils/tests": "^1.1.7",
+    "@shared-configs/eslint-config-node": "workspace:*",
+    "@shared-configs/prettier": "workspace:*",
+    "@shared-configs/typescript": "workspace:*",
+    "@sondr3/minitest": "^0.1.2",
+    "@types/node": "^18.19.39",
+    "@types/yargs": "^17.0.32",
+    "concurrently": "^8.2.2",
+    "eslint": "^8.57.0",
+    "prettier": "^3.3.3",
+    "typescript": "^5.5.4"
+  },
+  "engines": {
+    "node": "18.* || >= 20"
+  }
+}

packages/analyze-ember-project-dependencies/src/index.ts

@@ -0,0 +1,14 @@
+import { analyzeProject, createOptions } from './steps/index.js';
+import type { CodemodOptions } from './types/index.js';
+
+export function analyzeEmberProjectDependencies(
+  codemodOptions: CodemodOptions,
+): void {
+  const options = createOptions(codemodOptions);
+
+  const projectData = analyzeProject(options);
+
+  console.log(`✅ ${projectData.size} packages found\n`);
+
+  console.log(projectData);
+}

packages/analyze-ember-project-dependencies/src/steps/analyze-project.ts

@@ -0,0 +1,40 @@
+import { readPackageJson } from '@codemod-utils/json';
+
+import type { Options, ProjectData } from '../types/index.js';
+import {
+  analyzeEntities,
+  analyzePackageJson,
+  getPackageRoots,
+} from './analyze-project/index.js';
+
+export function analyzeProject(options: Options) {
+  const packageRoots = getPackageRoots(options);
+
+  const projectData: ProjectData = new Map();
+
+  packageRoots.forEach((packageRoot) => {
+    const packageJson = readPackageJson({ projectRoot: packageRoot });
+
+    if (!packageJson['name']) {
+      return;
+    }
+
+    const { dependencies, devDependencies, packageType } =
+      analyzePackageJson(packageJson);
+
+    const entities = analyzeEntities({
+      packageRoot,
+      packageType,
+    });
+
+    projectData.set(packageJson['name'], {
+      dependencies,
+      devDependencies,
+      entities,
+      packageRoot,
+      packageType,
+    });
+  });
+
+  return new Map([...projectData].sort());
+}

packages/analyze-ember-project-dependencies/src/steps/analyze-project/analyze-entities.ts

@@ -0,0 +1,68 @@
+import { doubleColonize } from '@codemod-utils/ember-cli-string';
+import { findFiles } from '@codemod-utils/files';
+
+import type { PackageType, ProjectDataEntities } from '../../types/index.js';
+
+const SOURCE = {
+  app: 'app',
+  node: undefined,
+  'v1-addon': 'addon',
+  'v2-addon': 'src',
+} as const;
+
+const ENTITY_TYPES = [
+  'components',
+  'helpers',
+  'modifiers',
+  'services',
+] as const;
+
+export function analyzeEntities(options: {
+  packageRoot: string;
+  packageType: PackageType;
+}): ProjectDataEntities {
+  const { packageRoot, packageType } = options;
+
+  const source = SOURCE[packageType];
+
+  const entities: ProjectDataEntities = {
+    components: [],
+    componentsDoubleColonized: [],
+    helpers: [],
+    modifiers: [],
+    services: [],
+  };
+
+  if (source === undefined) {
+    return entities;
+  }
+
+  ENTITY_TYPES.forEach((entityType) => {
+    const filePaths = findFiles(
+      `${source}/${entityType}/**/*.{gjs,gts,hbs,js,ts}`,
+      {
+        ignoreList: ['**/*.d.ts', '**/dist/**/*', '**/node_modules/**/*'],
+        projectRoot: packageRoot,
+      },
+    );
+
+    let entityNames = filePaths.map((filePath) => {
+      return filePath
+        .replace(new RegExp(`^${source}/${entityType}/`), '')
+        .replace(/\.(gjs|gts|hbs|js|ts)$/, '');
+    });
+
+    if (entityType === 'components') {
+      entityNames = Array.from(new Set(entityNames));
+
+      entities['components'] = entityNames;
+      entities['componentsDoubleColonized'] = entityNames.map(doubleColonize);
+
+      return;
+    }
+
+    entities[entityType] = entityNames;
+  });
+
+  return entities;
+}

packages/analyze-ember-project-dependencies/src/steps/analyze-project/analyze-package-json.ts

@@ -0,0 +1,51 @@
+import type { PackageJson } from '@codemod-utils/json';
+
+import type { PackageName, PackageType } from '../../types/index.js';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type EmberAddon = Record<string, any>;
+
+function getPackageType({
+  dependencies,
+  devDependencies,
+  emberAddon,
+}: {
+  dependencies: Set<PackageName>;
+  devDependencies: Set<PackageName>;
+  emberAddon?: EmberAddon;
+}): PackageType {
+  if (emberAddon) {
+    return emberAddon['version'] === 2 ? 'v2-addon' : 'v1-addon';
+  }
+
+  if (devDependencies.has('ember-source') || dependencies.has('ember-source')) {
+    return 'app';
+  }
+
+  return 'node';
+}
+
+export function analyzePackageJson(packageJson: PackageJson) {
+  const dependencies = new Set<PackageName>(
+    [
+      ...Object.keys(packageJson['dependencies'] ?? {}),
+      ...Object.keys(packageJson['peerDependencies'] ?? {}),
+    ].sort(),
+  );
+
+  const devDependencies = new Set<PackageName>(
+    [...Object.keys(packageJson['devDependencies'] ?? {})].sort(),
+  );
+
+  const packageType = getPackageType({
+    dependencies,
+    devDependencies,
+    emberAddon: packageJson['ember-addon'] as EmberAddon,
+  });
+
+  return {
+    dependencies,
+    devDependencies,
+    packageType,
+  };
+}