Fix fixtures for Embroider + TypeScript

simonihmig · simonihmig · commit 9cc0cf8d0895 · 2023-06-29T10:51:46.000+02:00
Fixes after review

Fixes after Dan's review

Fixes after rebase

Add declarations to gitignore
diff --git a/blueprints/addon/files/index.js b/blueprints/addon/files/index.js
@@ -1,5 +1,9 @@
 'use strict';
 
 module.exports = {
-  name: require('./package').name,
+  name: require('./package').name,<% if (typescript) {%>
+
+  options: {
+    'ember-cli-babel': { enableTypeScriptTransform: true },
+  },<% } %>
 };
diff --git a/blueprints/addon/files/tsconfig.declarations.json b/blueprints/addon/files/tsconfig.declarations.json
@@ -3,8 +3,8 @@
   "compilerOptions": {
     "declarationDir": "declarations",
     "emitDeclarationOnly": true,
-    "isolatedModules": false,
-    "noEmit": false
+    "noEmit": false,
+    "rootDir": "."
   },
-  "include": ["addon/**/*", "types/**/*", "addon-test-support/**/*"]
+  "include": ["addon", "addon-test-support"]
 }
diff --git a/blueprints/addon/files/tsconfig.json b/blueprints/addon/files/tsconfig.json
@@ -8,19 +8,11 @@
     "paths": {
       "dummy/tests/*": ["tests/*"],
       "dummy/*": ["tests/dummy/app/*", "app/*"],
-      "my-addon": ["addon"],
-      "my-addon/*": ["addon/*"],
-      "my-addon/test-support": ["addon-test-support"],
-      "my-addon/test-support/*": ["addon-test-support/*"],
+      "<%= addonName %>": ["addon"],
+      "<%= addonName %>/*": ["addon/*"],
+      "<%= addonName %>/test-support": ["addon-test-support"],
+      "<%= addonName %>/test-support/*": ["addon-test-support/*"],
       "*": ["types/*"]
     }
-  },
-  "include": [
-    "app/**/*",
-    "addon/**/*",
-    "tests/**/*",
-    "types/**/*",
-    "test-support/**/*",
-    "addon-test-support/**/*"
-  ]
+  }
 }
diff --git a/blueprints/addon/index.js b/blueprints/addon/index.js
@@ -84,13 +84,16 @@ module.exports = {
 
     // add scripts to build type declarations for TypeScript addons
     if (this.options.typescript) {
+      contents.devDependencies.rimraf = '^5.0.1';
+
       contents.scripts.prepack = 'tsc --project tsconfig.declarations.json';
       contents.scripts.postpack = 'rimraf declarations';
 
       contents.typesVersions = {
         '*': {
-          'test-support/*': ['declarations/addon-test-support/*'],
-          '*': ['declarations/addon/*'],
+          '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'],
         },
       };
     }
diff --git a/blueprints/app/files/gitignore b/blueprints/app/files/gitignore
@@ -1,5 +1,6 @@
 # compiled output
 /dist/
+/declarations/
 
 # dependencies
 /node_modules/
diff --git a/blueprints/app/files/package.json b/blueprints/app/files/package.json
@@ -36,7 +36,6 @@
     "@embroider/webpack": "^3.0.0<% } %>",
     "@glimmer/component": "^1.1.2",
     "@glimmer/tracking": "^1.1.2<% if (typescript) { %>",
-    "@glint/core": "^1.0.2",
     "@glint/environment-ember-loose": "^1.0.2",
     "@glint/template": "^1.0.2",
     "@tsconfig/ember": "^2.0.0",
diff --git a/blueprints/app/files/tsconfig.json b/blueprints/app/files/tsconfig.json
@@ -10,6 +10,5 @@
       "<%= name %>/*": ["app/*"],
       "*": ["types/*"]
     }
-  },
-  "include": ["app/**/*", "tests/**/*", "types/**/*"]
+  }
 }
diff --git a/tests/acceptance/new-test.js b/tests/acceptance/new-test.js
@@ -704,6 +704,7 @@ describe('Acceptance: ember new', function () {
       // check fixtures
       [
         '.ember-cli',
+        'index.js',
         'tests/helpers/index.ts',
         'tsconfig.json',
         'tsconfig.declarations.json',
diff --git a/tests/fixtures/addon/typescript/index.js b/tests/fixtures/addon/typescript/index.js
@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = {
+  name: require('./package').name,
+
+  options: {
+    'ember-cli-babel': { enableTypeScriptTransform: true },
+  },
+};
diff --git a/tests/fixtures/addon/typescript/package.json b/tests/fixtures/addon/typescript/package.json
@@ -10,11 +10,16 @@
   "author": "",
   "typesVersions": {
     "*": {
+      "test-support": [
+        "declarations/addon-test-support/index.d.ts"
+      ],
       "test-support/*": [
-        "declarations/addon-test-support/*"
+        "declarations/addon-test-support/*",
+        "declarations/addon-test-support/*/index.d.ts"
       ],
       "*": [
-        "declarations/addon/*"
+        "declarations/addon/*",
+        "declarations/addon/*/index.d.ts"
       ]
     }
   },
@@ -46,12 +51,11 @@
   },
   "devDependencies": {
     "@ember/optional-features": "^2.0.0",
-    "@ember/string": "^3.0.1",
-    "@ember/test-helpers": "^2.9.3",
-    "@embroider/test-setup": "^2.1.1",
+    "@ember/string": "^3.1.1",
+    "@ember/test-helpers": "^3.1.0",
+    "@embroider/test-setup": "^3.0.1",
     "@glimmer/component": "^1.1.2",
     "@glimmer/tracking": "^1.1.2",
-    "@glint/core": "^1.0.2",
     "@glint/environment-ember-loose": "^1.0.2",
     "@glint/template": "^1.0.2",
     "@tsconfig/ember": "^2.0.0",
@@ -78,39 +82,41 @@
     "@types/ember__utils": "^4.0.2",
     "@types/qunit": "^2.19.5",
     "@types/rsvp": "^4.0.4",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.59.8",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
+    "@typescript-eslint/parser": "^5.60.0",
     "broccoli-asset-rev": "^3.0.0",
-    "concurrently": "^8.0.1",
+    "concurrently": "^8.2.0",
     "ember-auto-import": "^2.6.3",
     "ember-cli": "~<%= emberCLIVersion %>",
-    "ember-cli-dependency-checker": "^3.3.1",
+    "ember-cli-clean-css": "^2.0.0",
+    "ember-cli-dependency-checker": "^3.3.2",
     "ember-cli-inject-live-reload": "^2.1.0",
     "ember-cli-sri": "^2.1.1",
     "ember-cli-terser": "^4.0.2",
     "ember-load-initializers": "^2.1.2",
     "ember-page-title": "^7.0.0",
-    "ember-qunit": "^6.2.0",
-    "ember-resolver": "^10.0.0",
-    "ember-source": "~4.12.0",
+    "ember-qunit": "^7.0.0",
+    "ember-resolver": "^10.1.1",
+    "ember-source": "~5.1.0-beta.1",
     "ember-source-channel-url": "^3.0.0",
-    "ember-template-lint": "^5.7.2",
+    "ember-template-lint": "^5.10.3",
     "ember-try": "^2.0.0",
-    "eslint": "^8.37.0",
+    "eslint": "^8.43.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-ember": "^11.5.0",
-    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-ember": "^11.8.0",
+    "eslint-plugin-n": "^16.0.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-qunit": "^7.3.4",
     "loader.js": "^4.7.0",
-    "prettier": "^2.8.7",
+    "prettier": "^2.8.8",
     "qunit": "^2.19.4",
     "qunit-dom": "^2.0.0",
-    "stylelint": "^15.4.0",
-    "stylelint-config-standard": "^32.0.0",
+    "rimraf": "^5.0.1",
+    "stylelint": "^15.8.0",
+    "stylelint-config-standard": "^33.0.0",
     "stylelint-prettier": "^3.0.0",
     "typescript": "^5.0.4",
-    "webpack": "^5.78.0"
+    "webpack": "^5.87.0"
   },
   "peerDependencies": {
     "ember-source": ">= 4.0.0"
diff --git a/tests/fixtures/addon/typescript/tsconfig.declarations.json b/tests/fixtures/addon/typescript/tsconfig.declarations.json
@@ -3,8 +3,8 @@
   "compilerOptions": {
     "declarationDir": "declarations",
     "emitDeclarationOnly": true,
-    "isolatedModules": false,
-    "noEmit": false
+    "noEmit": false,
+    "rootDir": "."
   },
-  "include": ["addon/**/*", "types/**/*", "addon-test-support/**/*"]
+  "include": ["addon", "addon-test-support"]
 }
diff --git a/tests/fixtures/addon/typescript/tsconfig.json b/tests/fixtures/addon/typescript/tsconfig.json
@@ -8,19 +8,11 @@
     "paths": {
       "dummy/tests/*": ["tests/*"],
       "dummy/*": ["tests/dummy/app/*", "app/*"],
-      "my-addon": ["addon"],
-      "my-addon/*": ["addon/*"],
-      "my-addon/test-support": ["addon-test-support"],
-      "my-addon/test-support/*": ["addon-test-support/*"],
+      "foo": ["addon"],
+      "foo/*": ["addon/*"],
+      "foo/test-support": ["addon-test-support"],
+      "foo/test-support/*": ["addon-test-support/*"],
       "*": ["types/*"]
     }
-  },
-  "include": [
-    "app/**/*",
-    "addon/**/*",
-    "tests/**/*",
-    "types/**/*",
-    "test-support/**/*",
-    "addon-test-support/**/*"
-  ]
+  }
 }
diff --git a/tests/fixtures/app/typescript-embroider/app/config/environment.d.ts b/tests/fixtures/app/typescript-embroider/app/config/environment.d.ts
@@ -0,0 +1,14 @@
+/**
+ * Type declarations for
+ *    import config from 'foo/config/environment'
+ */
+declare const config: {
+  environment: string;
+  modulePrefix: string;
+  podModulePrefix: string;
+  locationType: 'history' | 'hash' | 'none' | 'auto';
+  rootURL: string;
+  APP: Record<string, unknown>;
+};
+
+export default config;
diff --git a/tests/fixtures/app/typescript-embroider/ember-cli-build.js b/tests/fixtures/app/typescript-embroider/ember-cli-build.js
@@ -0,0 +1,20 @@
+'use strict';
+
+const EmberApp = require('ember-cli/lib/broccoli/ember-app');
+
+module.exports = function (defaults) {
+  const app = new EmberApp(defaults, {
+    'ember-cli-babel': { enableTypeScriptTransform: true },
+
+    // Add options here
+  });
+
+  const { Webpack } = require('@embroider/webpack');
+  return require('@embroider/compat').compatBuild(app, Webpack, {
+    skipBabel: [
+      {
+        package: 'qunit',
+      },
+    ],
+  });
+};
diff --git a/tests/fixtures/app/typescript-embroider/package.json b/tests/fixtures/app/typescript-embroider/package.json
@@ -0,0 +1,113 @@
+{
+  "name": "foo",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Small description for foo goes here",
+  "repository": "",
+  "license": "MIT",
+  "author": "",
+  "directories": {
+    "doc": "doc",
+    "test": "tests"
+  },
+  "scripts": {
+    "build": "ember build --environment=production",
+    "lint": "concurrently \"npm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:css": "stylelint \"**/*.css\"",
+    "lint:css:fix": "concurrently \"npm:lint:css -- --fix\"",
+    "lint:fix": "concurrently \"npm:lint:*:fix\" --names \"fix:\"",
+    "lint:hbs": "ember-template-lint .",
+    "lint:hbs:fix": "ember-template-lint . --fix",
+    "lint:js": "eslint . --cache",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "tsc --noEmit",
+    "start": "ember serve",
+    "test": "concurrently \"npm:lint\" \"npm:test:*\" --names \"lint,test:\"",
+    "test:ember": "ember test"
+  },
+  "devDependencies": {
+    "@ember/optional-features": "^2.0.0",
+    "@ember/string": "^3.1.1",
+    "@ember/test-helpers": "^3.1.0",
+    "@embroider/compat": "^3.0.2",
+    "@embroider/core": "^3.0.2",
+    "@embroider/webpack": "^3.0.0",
+    "@glimmer/component": "^1.1.2",
+    "@glimmer/tracking": "^1.1.2",
+    "@glint/environment-ember-loose": "^1.0.2",
+    "@glint/template": "^1.0.2",
+    "@tsconfig/ember": "^2.0.0",
+    "@types/ember": "^4.0.3",
+    "@types/ember-data": "^4.4.10",
+    "@types/ember-data__adapter": "^4.0.1",
+    "@types/ember-data__model": "^4.0.0",
+    "@types/ember-data__serializer": "^4.0.1",
+    "@types/ember-data__store": "^4.0.2",
+    "@types/ember__application": "^4.0.5",
+    "@types/ember__array": "^4.0.3",
+    "@types/ember__component": "^4.0.13",
+    "@types/ember__controller": "^4.0.4",
+    "@types/ember__debug": "^4.0.3",
+    "@types/ember__destroyable": "^4.0.1",
+    "@types/ember__engine": "^4.0.4",
+    "@types/ember__error": "^4.0.2",
+    "@types/ember__helper": "^4.0.1",
+    "@types/ember__modifier": "^4.0.3",
+    "@types/ember__object": "^4.0.5",
+    "@types/ember__owner": "^4.0.3",
+    "@types/ember__polyfills": "^4.0.1",
+    "@types/ember__routing": "^4.0.12",
+    "@types/ember__runloop": "^4.0.2",
+    "@types/ember__service": "^4.0.2",
+    "@types/ember__string": "^3.0.10",
+    "@types/ember__template": "^4.0.1",
+    "@types/ember__test": "^4.0.1",
+    "@types/ember__utils": "^4.0.2",
+    "@types/qunit": "^2.19.5",
+    "@types/rsvp": "^4.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
+    "@typescript-eslint/parser": "^5.60.0",
+    "broccoli-asset-rev": "^3.0.0",
+    "concurrently": "^8.2.0",
+    "ember-auto-import": "^2.6.3",
+    "ember-cli": "~<%= emberCLIVersion %>",
+    "ember-cli-app-version": "^6.0.1",
+    "ember-cli-babel": "^7.26.11",
+    "ember-cli-clean-css": "^2.0.0",
+    "ember-cli-dependency-checker": "^3.3.2",
+    "ember-cli-htmlbars": "^6.2.0",
+    "ember-cli-inject-live-reload": "^2.1.0",
+    "ember-data": "~5.1.0-beta.0",
+    "ember-fetch": "^8.1.2",
+    "ember-load-initializers": "^2.1.2",
+    "ember-modifier": "^4.1.0",
+    "ember-page-title": "^7.0.0",
+    "ember-qunit": "^7.0.0",
+    "ember-resolver": "^10.1.1",
+    "ember-source": "~5.1.0-beta.1",
+    "ember-template-lint": "^5.10.3",
+    "ember-welcome-page": "^7.0.2",
+    "eslint": "^8.43.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-ember": "^11.8.0",
+    "eslint-plugin-n": "^16.0.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-qunit": "^7.3.4",
+    "loader.js": "^4.7.0",
+    "prettier": "^2.8.8",
+    "qunit": "^2.19.4",
+    "qunit-dom": "^2.0.0",
+    "stylelint": "^15.8.0",
+    "stylelint-config-standard": "^33.0.0",
+    "stylelint-prettier": "^3.0.0",
+    "tracked-built-ins": "^3.1.1",
+    "typescript": "^5.0.4",
+    "webpack": "^5.87.0"
+  },
+  "engines": {
+    "node": "16.* || >= 18"
+  },
+  "ember": {
+    "edition": "octane"
+  }
+}
diff --git a/tests/fixtures/app/typescript-embroider/tsconfig.json b/tests/fixtures/app/typescript-embroider/tsconfig.json
diff --git a/tests/fixtures/app/typescript-embroider/types/ember-data/types/registries/model.d.ts b/tests/fixtures/app/typescript-embroider/types/ember-data/types/registries/model.d.ts
diff --git a/tests/fixtures/app/typescript-embroider/types/global.d.ts b/tests/fixtures/app/typescript-embroider/types/global.d.ts
diff --git a/tests/fixtures/app/typescript/package.json b/tests/fixtures/app/typescript/package.json
diff --git a/tests/fixtures/app/typescript/tsconfig.json b/tests/fixtures/app/typescript/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,5 @@`
`10`	`10`	`"<%= name %>/": ["app/"],`
`11`	`11`	`"": ["types/"]`
`12`	`12`	`}`
`13`		`- },`
`14`		`- "include": ["app/*/", "tests/*/", "types/*/"]`
	`13`	`+ }`
`15`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -704,6 +704,7 @@ describe('Acceptance: ember new', function () {`
`704`	`704`	`// check fixtures`
`705`	`705`	`[`
`706`	`706`	`'.ember-cli',`
	`707`	`+ 'index.js',`
`707`	`708`	`'tests/helpers/index.ts',`
`708`	`709`	`'tsconfig.json',`
`709`	`710`	`'tsconfig.declarations.json',`