BREAKING Migrate to V2 Addon

[BlueCutOfficial]

Breaking

Migrate to V2 Addon

Follow the guide https://github.com/embroider-build/embroider/blob/main/PORTING-ADDONS-TO-V2.md to migrate ember-slugify to V2 Addon.

---

See below various troubleshooting that could be handy for other addons:

.mjs extension for rollup.config

⚠️ By following the doc PORTING-ADDONS-TO-V2 as it is, the addon built ran into:

RollupError: Node tried to load your configuration file as CommonJS even though it is likely an ES module. To resolve this, change the extension of your configuration to ".mjs", set "type": "module" in your package.json file or pass the "--bundleConfigAsCjs" flag.

Based on ember-welcome-page structure, rollup.config.js was replaced with rollup.config.mjs. It solved the issue.

ember-try 3.0.0-beta.1

With ember-try 2.0.0, running yarn test:ember-compatibility triggered the following error coming from fs-extra:

Source and destination must not be the same

This bug was fixed in ember-try 3.0.0-beta.1 with PR ember-try#912 that downgrades fs-extra.

Build before testing

The test-app relies on the addon build. Installing the dependencies is not enough to make the tests run, you also need to build the addon first:

# ci.yml

- name: Build Addon
  run: yarn build

- name: Run Tests
  run: yarn test

Top-level package.json:

"scripts": {
    "build": "yarn workspace ember-slugify run build",
    "test": "yarn workspace test-app test"
 }

[GreatWizard]

• keep .prettierignore at root level
• keep .prettierrc.js at root level
• remove ember-clugify/config/environment
• remove dist dir in ember-slugify
• chqnge gitignore content by https://github.com/embroider-build/addon-blueprint/blob/main/files/gitignore
• update ember/slugify/.eslintignore with https://github.com/embroider-build/addon-blueprint/blob/main/files/__addonLocation__/.eslintignore (wontdo)
• restore ember-cli-update into this file /config/ember-cli-update.json (wontdo)

[ndekeister-us]

Running yarn lint with this file content works, I believe other rules/overrides are not needed in test-app directory (they are only needed for files in ./ember-slugify/src/*)

'use strict'

module.exports = {
  extends: ['recommended', 'stylistic'],

  overrides: [
    {
      files: ['**/tests/**/*.{js,ts}'],
      rules: {
        'eol-last': 'off',
      },
    },
  ],
}

[BlueCutOfficial]

Hey, I think I am going to merge the PR as it is once green because it really starts to hit hard on my mental health and I want to unblock the dependencies update. Let's have a better look at the lint config afterward :)

[ndekeister-us]

Could you explain why it is needed?

[BlueCutOfficial]

I blindly followed the doc that says

Grab the example babel config and save it as addon/babel.config.json

😅

[ndekeister-us]

Could be nice to see if they are really needed on every addon or if we can remove them