Convert to V2 addon #411

herzzanu · 2023-03-15T11:25:17Z

No description provided.

SkoebaSteve · 2023-03-22T09:51:29Z

@herzzanu ok to wait with merging this until we release v2?

herzzanu · 2023-03-29T08:33:40Z

@SkoebaSteve are we good to merge at this point or waiting for something else? Happy to help and unblock the situation.

.github/workflows/ci.yml

@@ -46,7 +50,7 @@ jobs:
      - name: Install Dependencies
        run: yarn install --frozen-lockfile
      - name: Run Tests
-        run: yarn test:ember
+        run: yarn test


anas7asia · 2023-04-26T14:47:51Z

.github/workflows/ci.yml

@@ -77,4 +80,5 @@ jobs:
      - name: Install Dependencies
        run: yarn install --frozen-lockfile
      - name: Run Tests
-        run: ./node_modules/.bin/ember try:one ${{ matrix.try-scenario }}
+        run: yarn ember try:one ${{ matrix.try-scenario }}
+        working-directory: ./test-app


Suggested change

working-directory: ./test-app

working-directory: test-app

We can make it even a bit shorter 😄

anas7asia · 2023-04-26T14:49:07Z

Maybe we can add a prettier configuration for the addon as well?

anas7asia · 2023-04-26T14:51:15Z

ember-launch-darkly/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)


This file can be left on the root level, it is copied by rollup when publishing

anas7asia · 2023-04-26T14:58:31Z

ember-launch-darkly/README.md

README can be left on the root level as well, it is copied by rollup when publishing:

// Copy Readme and License into published package copy({ targets: [ { src: '../README.md', dest: '.' }, { src: '../LICENSE.md', dest: '.' }, ], }),

anas7asia · 2023-04-26T15:00:05Z

test-app/ember-cli-build.js

+  // please specify an object with the list of modules as keys
+  // along with the exports of each module as its value.
+
+  return app.toTree();


Should we keep maybeEmbroider?

const { maybeEmbroider } = require('@embroider/test-setup'); return maybeEmbroider(app, { skipBabel: [ { package: 'qunit', }, ], });

anas7asia · 2023-05-05T12:46:54Z

ember-launch-darkly/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "ember-launch-darkly",
+  "version": "2.2.0",


Isn't it v3.0.0 now?

anas7asia · 2023-05-05T12:49:11Z

ember-launch-darkly/package.json

+  },
+  "dependencies": {
+    "@embroider/addon-shim": "^1.0.0",
+    "launchdarkly-js-client-sdk": "^2.24.2",


It was upgraded to ^3.1.1

anas7asia · 2023-05-05T12:50:55Z

ember-launch-darkly/package.json

+    "@rollup/plugin-babel": "^6.0.3",
+    "babel-eslint": "^10.1.0",
+    "concurrently": "^7.6.0",
+    "ember-source": "4.11.0",


Do you think we can add it as a peer dep? Example: https://github.com/adopted-ember-addons/ember-launch-darkly/blob/master/package.json#L77

herzzanu · 2023-05-05T13:02:22Z

Maybe we can add a prettier configuration for the addon as well?

That's a great idea. I prefer to add it in a separate PR, once we merge, since it was not there before.

ember-launch-darkly/rollup.config.mjs

+  plugins: [
+    // These are the modules that users should be able to import from your
+    // addon. Anything not listed here may get optimized away.
+    addon.publicEntrypoints(['**/*.js']),


ember-launch-darkly/rollup.config.mjs

+    // "app" tree. Things in here should also be in publicEntrypoints above, but
+    // not everything in publicEntrypoints necessarily needs to go here.
+    addon.appReexports(['helpers/**/*.js']),
+


package.json

anas7asia · 2023-05-05T13:34:29Z

test-app/.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig helps developers define and maintain consistent


Should it stay at the root level? 🤔

test-app/.prettierrc.js

@@ -0,0 +1,12 @@
+'use strict';
+
+module.exports = {


anas7asia · 2023-05-05T13:47:05Z

test-app/README.md

+
+* `git clone <repository-url>` this repository
+* `cd test-app`
+* `npm install`


Suggested change

* `npm install`

* `yarn install`

anas7asia · 2023-05-05T13:48:07Z

test-app/README.md

+* `npm run lint`
+* `npm run lint:fix`


Suggested change

* `npm run lint`

* `npm run lint:fix`

* `yarn lint`

* `yarn lint:fix`

test-app/app/identified-user/controller.js


 import { variation } from 'ember-launch-darkly';

 export default class IdentifiedUserController extends Controller {
  get shape() {
-    return capitalize(variation('shape'));
+    return variation('shape');


test-app/app/index/template.hbs

+<br />
+<br />
+
+{{#let (component (ensure-safe-component this.shape)) as |Shape|}}


anas7asia · 2023-05-05T13:56:48Z

test-app/config/ember-cli-update.json

-            "--yarn",
-            "--no-welcome"
+            "--no-welcome",
+            "--ci-provider=github"


Suggested change

"--ci-provider=github"

"--yarn"

test-app/config/ember-try.js

@@ -23,18 +23,8 @@ module.exports = async function () {
          },
        },
      },
-      {
-        name: 'ember-lts-4.4',


test-app/config/ember-try.js

-            edition: 'classic',
+        },
+      }),
+      embroiderOptimized({


test-app/package.json

+  "description": "Small description for test-app goes here",
+  "repository": "",
+  "license": "MIT",
+  "author": "",


test-app/testem.js

@@ -11,9 +11,7 @@ module.exports = {
      ci: [
        // --no-sandbox is needed when running Chrome inside a container
        process.env.CI ? '--no-sandbox' : null,
-        process.platform === 'darwin' ? '--crash-dumps-dir=/tmp' : null, // Fix for https://superuser.com/questions/1292863/chrome-crashpad-crashes-on-xattr


herzzanu · 2023-05-10T13:52:42Z

ember-launch-darkly/package.json

+    "./-sdk/initialize": "./dist/-sdk/initialize.js",
+    "./-sdk/variation": "./dist/-sdk/variation.js",
+    "./addon-main.js": "./addon-main.js"
+  }


I think we can keep them Added.

Alright, thanks!

tniezurawski · 2023-09-25T16:16:07Z

@herzzanu This might be a bit odd question but I wanted to help the community to move some addons from V1 to V2 so... how did you know what to do? 😅 Is there some "v1 to v2 TODO list" resource?

herzzanu · 2023-09-25T16:45:13Z

@herzzanu This might be a bit odd question, but I wanted to help the community to move some addons from V1 to V2 so... how did you know what to do? 😅 Is there some "v1 to v2 TODO list" resource?

@tniezurawski, that's great to hear 🙌 Here's a non-exhaustive list of resources that could help:

Guides

Tools

A couple of v2 addons that could serve as inspiration

The list of V2 add-ons can go on. It's also a good idea to find the specific commits that helped migrate these addons to understand the nature of the changes. Hope it helps. Happy to help if you need anything specific on any of the projects you plan to work on.

tniezurawski · 2023-09-26T07:10:24Z

Great stuff @herzzanu! Thank you!

herzzanu force-pushed the convert-to-addon-V2 branch 9 times, most recently from 0ca168c to bf02610 Compare March 16, 2023 23:22

herzzanu self-assigned this Mar 16, 2023

herzzanu force-pushed the convert-to-addon-V2 branch from bf02610 to 8ce8d1b Compare March 16, 2023 23:38

herzzanu requested a review from achambers March 16, 2023 23:38

herzzanu force-pushed the convert-to-addon-V2 branch 5 times, most recently from 9e98b01 to f6d56df Compare March 18, 2023 01:51

anas7asia reviewed Apr 26, 2023

View reviewed changes

.github/workflows/ci.yml Outdated

@@ -46,7 +50,7 @@ jobs:

- name: Install Dependencies

run: yarn install --frozen-lockfile

- name: Run Tests

run: yarn test:ember

run: yarn test

This comment was marked as outdated.

Sign in to view

anas7asia reviewed Apr 26, 2023

View reviewed changes