@ember-tooling/classic-build-addon-blueprint 0.0.0 → 6.7.0-alpha.3

package/additional-package.json

@@ -0,0 +1,19 @@
+{
+  "keywords": [
+    "ember-addon"
+  ],
+  "scripts": {
+    "test:ember-compatibility": "ember try:each"
+  },
+  "devDependencies": {
+    "@embroider/test-setup": "^4.0.0",
+    "ember-source-channel-url": "^3.0.0",
+    "ember-try": "^4.0.0"
+  },
+  "peerDependencies": {
+    "ember-source": ">= 4.0.0"
+  },
+  "ember-addon": {
+    "configPath": "tests/dummy/config"
+  }
+}

package/files/.github/workflows/ci.yml

@@ -0,0 +1,87 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request: {}
+
+concurrency:
+  group: ci-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: "Tests"
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3<% if (pnpm) { %>
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9<% } %>
+      - name: Install Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: <%= pnpm ? 'pnpm' : yarn ? 'yarn' : 'npm' %>
+      - name: Install Dependencies
+        run: <%= pnpm ? 'pnpm install --frozen-lockfile' : yarn ? 'yarn install --frozen-lockfile' : 'npm ci' %>
+      - name: Lint
+        run: <%= pnpm ? 'pnpm' : yarn ? 'yarn' : 'npm run' %> lint
+      - name: Run Tests
+        run: <%= pnpm ? 'pnpm' : yarn ? 'yarn' : 'npm run' %> test:ember
+
+  floating:
+    name: "Floating Dependencies"
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3<% if (pnpm) { %>
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9<% } %>
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: <%= pnpm ? 'pnpm' : yarn ? 'yarn' : 'npm' %>
+      - name: Install Dependencies
+        run: <%= pnpm ? 'pnpm install --no-lockfile' : yarn ? 'yarn install --no-lockfile' : 'npm install --no-shrinkwrap' %>
+      - name: Run Tests
+        run: <%= pnpm ? 'pnpm' : yarn ? 'yarn' : 'npm run' %> test:ember
+
+  try-scenarios:
+    name: ${{ matrix.try-scenario }}
+    runs-on: ubuntu-latest
+    needs: "test"
+    timeout-minutes: 10
+
+    strategy:
+      fail-fast: false
+      matrix:
+        try-scenario:
+          - ember-lts-5.8
+          - ember-lts-5.12
+          - ember-release
+          - ember-beta
+          - ember-canary
+          - embroider-safe
+          - embroider-optimized
+
+    steps:
+      - uses: actions/checkout@v3<% if (pnpm) { %>
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9<% } %>
+      - name: Install Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: <%= pnpm ? 'pnpm' : yarn ? 'yarn' : 'npm' %>
+      - name: Install Dependencies
+        run: <%= pnpm ? 'pnpm install --frozen-lockfile' : yarn ? 'yarn install --frozen-lockfile' : 'npm ci' %>
+      - name: Run Tests
+        run: ./node_modules/.bin/ember try:one ${{ matrix.try-scenario }}

package/files/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# How To Contribute
+
+## Installation
+
+- `git clone <repository-url>`
+- `cd <%= addonDirectory %>`
+- `<% if (pnpm) { %>pnpm<% } else if (yarn) { %>yarn<% } else { %>npm<% } %> install`
+
+## Linting
+
+- `<%= invokeScriptPrefix %> lint`
+- `<%= invokeScriptPrefix %> lint:fix`
+
+## Running tests
+
+- `<%= invokeScriptPrefix %> test` – Runs the test suite on the current Ember version
+- `<%= invokeScriptPrefix %> test:ember <% if (npm) { %>-- <% } %>--server` – Runs the test suite in "watch mode"
+- `<%= invokeScriptPrefix %> test:ember-compatibility` – Runs the test suite against multiple Ember versions
+
+## Running the dummy application
+
+- `<%= invokeScriptPrefix %> start`
+- Visit the dummy application at [http://localhost:4200](http://localhost:4200).
+
+For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).

package/files/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) <%= year %>
+
+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.

package/files/README.md

@@ -0,0 +1,27 @@
+# <%= addonName %>
+
+[Short description of the addon.]
+
+## Compatibility
+
+- Ember.js v5.8 or above
+- Ember CLI v5.8 or above
+- Node.js v18 or above
+
+## Installation
+
+```
+ember install <%= addonName %>
+```
+
+## Usage
+
+[Longer description of how to use the addon in apps.]
+
+## Contributing
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

package/files/config/ember-try.js

@@ -0,0 +1,54 @@
+'use strict';
+
+const getChannelURL = require('ember-source-channel-url');
+const { embroiderSafe, embroiderOptimized } = require('@embroider/test-setup');
+
+module.exports = async function () {
+  return {
+    packageManager: '<%= packageManager %>',
+    scenarios: [
+      {
+        name: 'ember-lts-5.8',
+        npm: {
+          devDependencies: {
+            'ember-source': '~5.8.0',
+          },
+        },
+      },
+      {
+        name: 'ember-lts-5.12',
+        npm: {
+          devDependencies: {
+            'ember-source': '~5.12.0',
+          },
+        },
+      },
+      {
+        name: 'ember-release',
+        npm: {
+          devDependencies: {
+            'ember-source': await getChannelURL('release'),
+          },
+        },
+      },
+      {
+        name: 'ember-beta',
+        npm: {
+          devDependencies: {
+            'ember-source': await getChannelURL('beta'),
+          },
+        },
+      },
+      {
+        name: 'ember-canary',
+        npm: {
+          devDependencies: {
+            'ember-source': await getChannelURL('canary'),
+          },
+        },
+      },
+      embroiderSafe(),
+      embroiderOptimized(),
+    ],
+  };
+};

package/files/config/optional-features.json

@@ -0,0 +1,6 @@
+{
+  "application-template-wrapper": false,
+  "default-async-observers": true,
+  "jquery-integration": false,
+  "template-only-glimmer-components": true
+}

package/files/ember-cli-build.js

@@ -0,0 +1,27 @@
+'use strict';
+
+const EmberAddon = require('ember-cli/lib/broccoli/ember-addon');
+
+module.exports = function (defaults) {
+  const app = new EmberAddon(defaults, {
+    <% if (typescript) {%>'ember-cli-babel': { enableTypeScriptTransform: true },
+
+    <% } %>// Add options here
+  });
+
+  /*
+    This build file specifies the options for the dummy test app of this
+    addon, located in `/tests/dummy`
+    This build file does *not* influence how the addon or the app using it
+    behave. You most likely want to be modifying `./index.js` or app's build file
+  */
+
+  const { maybeEmbroider } = require('@embroider/test-setup');
+  return maybeEmbroider(app, {
+    skipBabel: [
+      {
+        package: 'qunit',
+      },
+    ],
+  });
+};

package/files/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = {
+  name: require('./package').name,<% if (typescript) {%>
+
+  options: {
+    'ember-cli-babel': { enableTypeScriptTransform: true },
+  },<% } %>
+};

package/files/npmignore

@@ -0,0 +1,28 @@
+# compiled output
+/dist/
+/tmp/
+
+# misc
+/.editorconfig
+/.ember-cli
+/.env*
+/.eslintcache
+/.git/
+/.github/
+/.gitignore
+/.prettierignore
+/.prettierrc.js
+/.stylelintignore
+/.stylelintrc.js
+/.template-lintrc.js
+/.watchmanconfig
+/CONTRIBUTING.md
+/ember-cli-build.js
+/eslint.config.mjs
+/testem.js
+/tests/
+/tsconfig.declarations.json
+/tsconfig.json
+/yarn-error.log
+/yarn.lock
+.gitkeep

package/files/tsconfig.declarations.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "declarationDir": "declarations",
+    "emitDeclarationOnly": true,
+    "noEmit": false,
+    "rootDir": "."
+  },
+  "include": ["addon", "addon-test-support"]
+}

package/files/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "@tsconfig/ember/tsconfig.json",
+  "glint": {
+    "environment": ["ember-loose", "ember-template-imports"]
+  },
+  "compilerOptions": {
+    // The combination of `baseUrl` with `paths` allows Ember's classic package
+    // layout, which is not resolvable with the Node resolution algorithm, to
+    // work with TypeScript.
+    "baseUrl": ".",
+    "paths": {
+      "dummy/tests/*": ["tests/*"],
+      "dummy/*": ["tests/dummy/app/*", "app/*"],
+      "<%= addonName %>": ["addon"],
+      "<%= addonName %>/*": ["addon/*"],
+      "<%= addonName %>/test-support": ["addon-test-support"],
+      "<%= addonName %>/test-support/*": ["addon-test-support/*"],
+      "*": ["types/*"]
+    },
+    "types": ["ember-source/types"]
+  }
+}

package/index.js

@@ -0,0 +1,319 @@
+'use strict';
+
+const fs = require('fs-extra');
+const path = require('path');
+const walkSync = require('walk-sync');
+const chalk = require('chalk');
+const stringUtil = require('ember-cli-string-utils');
+const merge = require('lodash/merge');
+const uniq = require('lodash/uniq');
+const SilentError = require('silent-error');
+const { sortPackageJson } = require('sort-package-json');
+
+let date = new Date();
+
+const normalizeEntityName = require('ember-cli-normalize-entity-name');
+
+const directoryForPackageName = require('@ember-tooling/blueprint-model/utilities/directory-for-package-name');
+const FileInfo = require('@ember-tooling/blueprint-model/utilities/file-info');
+
+const blueprintVersion = require('./package.json').version;
+
+function stringifyAndNormalize(contents) {
+  return `${JSON.stringify(contents, null, 2)}\n`;
+}
+
+const replacers = {
+  'package.json'(content) {
+    return this.updatePackageJson(content);
+  },
+};
+
+const ADDITIONAL_PACKAGE = require('./additional-package.json');
+
+const description = 'The default blueprint for ember-cli addons.';
+module.exports = {
+  description,
+  appBlueprintName: 'app',
+
+  shouldTransformTypeScript: true,
+
+  filesToRemove: [
+    'tests/dummy/app/styles/.gitkeep',
+    'tests/dummy/app/templates/.gitkeep',
+    'tests/dummy/app/views/.gitkeep',
+    'tests/dummy/public/.gitkeep',
+    'Brocfile.js',
+    'testem.json',
+  ],
+
+  updatePackageJson(content) {
+    let contents = JSON.parse(content);
+
+    contents.name = stringUtil.dasherize(this.options.entity.name);
+    contents.description = this.description;
+
+    delete contents.private;
+
+    contents.dependencies = contents.dependencies || {};
+    contents.devDependencies = contents.devDependencies || {};
+
+    // npm doesn't like it when we have something in both deps and devDeps
+    // and dummy app still uses it when in deps
+    contents.dependencies['ember-cli-babel'] = contents.devDependencies['ember-cli-babel'];
+    delete contents.devDependencies['ember-cli-babel'];
+
+    // Addons must bring in their own version of `@babel/core` when using
+    // `ember-cli-babel` >= v8. More info:
+    // https://github.com/babel/ember-cli-babel/blob/master/UPGRADING.md#upgrade-path-for-addons
+    contents.dependencies['@babel/core'] = contents.devDependencies['@babel/core'];
+    delete contents.devDependencies['@babel/core'];
+
+    // Move ember-cli-htmlbars into the dependencies of the addon blueprint by default
+    // to prevent error:
+    // `Addon templates were detected but there are no template compilers registered for (addon-name)`
+    contents.dependencies['ember-cli-htmlbars'] = contents.devDependencies['ember-cli-htmlbars'];
+    delete contents.devDependencies['ember-cli-htmlbars'];
+
+    contents.dependencies['ember-template-imports'] = contents.devDependencies['ember-template-imports'];
+    delete contents.devDependencies['ember-template-imports'];
+
+    // 95% of addons don't need ember-data or ember-fetch, make them opt-in instead
+    let deps = Object.keys(contents.devDependencies);
+    for (let depName of deps) {
+      if (depName.includes('ember-data') || depName.includes('warp-drive')) {
+        delete contents.devDependencies[depName];
+      }
+    }
+
+    // Per RFC #811, addons should not have this dependency.
+    // @see https://github.com/emberjs/rfcs/blob/master/text/0811-element-modifiers.md#detailed-design
+    delete contents.devDependencies['ember-modifier'];
+
+    // Per RFC #812, addons should not have this dependency.
+    // @see https://github.com/emberjs/rfcs/blob/master/text/0812-tracked-built-ins.md#detailed-design
+    delete contents.devDependencies['tracked-built-ins'];
+
+    // 100% of addons don't need ember-cli-app-version, make it opt-in instead
+    delete contents.devDependencies['ember-cli-app-version'];
+
+    // add scripts to build type declarations for TypeScript addons
+    if (this.options.typescript) {
+      contents.devDependencies.rimraf = '^5.0.10';
+
+      contents.scripts.prepack = 'tsc --project tsconfig.declarations.json';
+      contents.scripts.postpack = 'rimraf declarations';
+
+      contents.typesVersions = {
+        '*': {
+          'test-support': ['declarations/addon-test-support/index.d.ts'],
+          'test-support/*': ['declarations/addon-test-support/*', 'declarations/addon-test-support/*/index.d.ts'],
+          '*': ['declarations/addon/*', 'declarations/addon/*/index.d.ts'],
+        },
+      };
+    }
+
+    merge(contents, ADDITIONAL_PACKAGE);
+
+    return stringifyAndNormalize(sortPackageJson(contents));
+  },
+
+  /**
+   * @override
+   *
+   * This modification of buildFileInfo allows our differing
+   * input files to output to a single file, depending on the options.
+   * For example:
+   *
+   *   for javascript,
+   *     _ts_eslint.config.mjs is deleted
+   *     _js_eslint.config.mjs is renamed to eslint.config.mjs
+   *
+   *   for typescript,
+   *     _js_eslint.config.mjs is deleted
+   *     _ts_eslint.config.mjs is renamed to eslint.config.mjs
+   */
+  buildFileInfo(intoDir, templateVariables, file, commandOptions) {
+    if (file.startsWith('_js_') || file.startsWith('_ts_')) {
+      let fileInfo = this._super.buildFileInfo.apply(this, arguments);
+
+      if (file.includes('_js_')) {
+        if (commandOptions.typescript) {
+          return null;
+        }
+
+        fileInfo.outputBasePath = fileInfo.outputPath.replace('_js_', '');
+        fileInfo.outputPath = fileInfo.outputPath.replace('_js_', '');
+        fileInfo.displayPath = fileInfo.outputPath.replace('_js_', '');
+        return fileInfo;
+      }
+
+      if (file.includes('_ts_')) {
+        if (!commandOptions.typescript) {
+          return null;
+        }
+
+        fileInfo.outputBasePath = fileInfo.outputPath.replace('_ts_', '');
+        fileInfo.outputPath = fileInfo.outputPath.replace('_ts_', '');
+        fileInfo.displayPath = fileInfo.outputPath.replace('_ts_', '');
+        return fileInfo;
+      }
+
+      return fileInfo;
+    }
+
+    let mappedPath = this.mapFile(file, templateVariables);
+    let options = {
+      action: 'write',
+      outputBasePath: path.normalize(intoDir),
+      outputPath: path.join(intoDir, mappedPath),
+      displayPath: path.normalize(mappedPath),
+      inputPath: this.srcPath(file),
+      templateVariables,
+      ui: this.ui,
+    };
+
+    if (file in replacers) {
+      options.replacer = replacers[file].bind(this);
+    }
+
+    return new FileInfo(options);
+  },
+
+  beforeInstall() {
+    const prependEmoji = require('@ember-tooling/blueprint-model/utilities/prepend-emoji');
+
+    this.ui.writeLine(chalk.blue(`@ember-tooling/classic-build-addon-blueprint v${blueprintVersion}`));
+    this.ui.writeLine('');
+    this.ui.writeLine(prependEmoji('✨', `Creating a new Ember addon in ${chalk.yellow(process.cwd())}:`));
+  },
+
+  locals(options) {
+    let entity = { name: 'dummy' };
+    let rawName = entity.name;
+    let name = stringUtil.dasherize(rawName);
+    let namespace = stringUtil.classify(rawName);
+
+    let addonEntity = options.entity;
+    let addonRawName = addonEntity.name;
+    let addonName = stringUtil.dasherize(addonRawName);
+    let addonNamespace = stringUtil.classify(addonRawName);
+
+    let hasOptions = options.welcome || options.packageManager || options.ciProvider;
+    let blueprintOptions = '';
+    if (hasOptions) {
+      let indent = `\n            `;
+      let outdent = `\n          `;
+
+      blueprintOptions =
+        indent +
+        [
+          options.welcome && '"--welcome"',
+          options.packageManager === 'yarn' && '"--yarn"',
+          options.packageManager === 'pnpm' && '"--pnpm"',
+          options.ciProvider && `"--ci-provider=${options.ciProvider}"`,
+          options.typescript && `"--typescript"`,
+        ]
+          .filter(Boolean)
+          .join(',\n            ') +
+        outdent;
+    }
+
+    let invokeScriptPrefix = 'npm run';
+
+    if (options.packageManager === 'yarn') {
+      invokeScriptPrefix = 'yarn';
+    }
+
+    if (options.packageManager === 'pnpm') {
+      invokeScriptPrefix = 'pnpm';
+    }
+
+    return {
+      addonDirectory: directoryForPackageName(addonName),
+      name,
+      modulePrefix: name,
+      namespace,
+      addonName,
+      addonNamespace,
+      blueprintVersion,
+      year: date.getFullYear(),
+      yarn: options.packageManager === 'yarn',
+      pnpm: options.packageManager === 'pnpm',
+      npm: options.packageManager !== 'yarn' && options.packageManager !== 'pnpm',
+      invokeScriptPrefix,
+      welcome: options.welcome,
+      blueprint: 'addon',
+      blueprintOptions,
+      embroider: false,
+      lang: options.lang,
+      emberData: options.emberData,
+      ciProvider: options.ciProvider,
+      typescript: options.typescript,
+      strict: options.strict,
+      packageManager: options.packageManager ?? 'npm',
+    };
+  },
+
+  files(options) {
+    let appFiles = this.lookupBlueprint(this.appBlueprintName).files(options);
+    let addonFilesPath = this.filesPath(this.options);
+    let ignore = [];
+
+    if (this.options.ciProvider !== 'github') {
+      ignore.push('.github');
+    }
+
+    let addonFiles = walkSync(addonFilesPath, { ignore });
+
+    if (options.packageManager !== 'pnpm') {
+      addonFiles = addonFiles.filter((file) => !file.endsWith('.npmrc'));
+    }
+
+    if (!options.typescript) {
+      addonFiles = addonFiles.filter((file) => !file.startsWith('tsconfig.') && !file.endsWith('.d.ts'));
+    }
+
+    return uniq(appFiles.concat(addonFiles));
+  },
+
+  mapFile() {
+    let result = this._super.mapFile.apply(this, arguments);
+    return this.fileMapper(result);
+  },
+
+  fileMap: {
+    '^app/.gitkeep': 'app/.gitkeep',
+    '^app.*': 'tests/dummy/:path',
+    '^config.*': 'tests/dummy/:path',
+    '^public.*': 'tests/dummy/:path',
+
+    '^npmignore': '.npmignore',
+  },
+
+  fileMapper(path) {
+    for (let pattern in this.fileMap) {
+      if (new RegExp(pattern).test(path)) {
+        return this.fileMap[pattern].replace(':path', path);
+      }
+    }
+
+    return path;
+  },
+
+  normalizeEntityName(entityName) {
+    entityName = normalizeEntityName(entityName);
+
+    if (this.project.isEmberCLIProject() && !this.project.isEmberCLIAddon()) {
+      throw new SilentError('Generating an addon in an existing ember-cli project is not supported.');
+    }
+
+    return entityName;
+  },
+
+  srcPath(file) {
+    let path = `${this.path}/files/${file}`;
+    let superPath = `${this.lookupBlueprint(this.appBlueprintName).path}/files/${file}`;
+    return fs.existsSync(path) ? path : superPath;
+  },
+};

package/package.json

@@ -1,8 +1,28 @@
 {
   "name": "@ember-tooling/classic-build-addon-blueprint",
-  "version": "0.0.0",
-  "description": "",
-  "keywords": [],
-  "author": "",
-  "license": "MIT"
-}
+  "version": "6.7.0-alpha.3",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ember-cli/ember-cli.git",
+    "directory": "packages/addon-blueprint"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "ember-cli-normalize-entity-name": "^1.0.0",
+    "ember-cli-string-utils": "^1.1.0",
+    "fs-extra": "^11.3.0",
+    "lodash": "^4.17.21",
+    "silent-error": "^1.1.1",
+    "sort-package-json": "^2.12.0",
+    "walk-sync": "^3.0.0",
+    "@ember-tooling/blueprint-model": "0.0.2"
+  },
+  "release-plan": {
+    "semverIncrementAs": {
+      "minor": "prerelease",
+      "patch": "prerelease"
+    },
+    "semverIncrementTag": "alpha",
+    "publishTag": "alpha"
+  }
+}