adding glint support

Author: gossi

.gitignore

@@ -2,6 +2,7 @@
 
 # compiled output
 dist/
+declarations/
 tmp/
 
 # dependencies

ember-element-helper/babel.config.json

@@ -1,4 +1,5 @@
 {
+  "presets": ["@babel/preset-typescript"],
   "plugins": [
     "@embroider/addon-dev/template-colocation-plugin",
     ["@babel/plugin-proposal-decorators", { "legacy": true }],

ember-element-helper/package.json

@@ -11,19 +11,27 @@
     "dynamic element"
   ],
   "exports": {
-    ".": "./dist/index.js",
-    "./*": "./dist/*"
+    ".": {
+      "types": "./declarations/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./*": {
+      "types": "./declarations/*.d.ts",
+      "default": "./dist/*"
+    },
+    "./addon-main.js": "./addon-main.cjs"
   },
   "files": [
     "dist",
+    "declarations",
     "addon-main.cjs",
     "CHANGELOG.md",
     "README.md"
   ],
   "scripts": {
     "start": "concurrently 'npm:watch:*'",
     "build": "concurrently 'npm:build:*'",
-    "build:js": "rollup -c ./rollup.config.js",
+    "build:js": "rollup -c",
     "build:docs": "cp ../README.md ./README.md",
     "watch:js": "rollup -c --watch --no-watch.clearScreen",
     "lint": "concurrently 'npm:lint:js'",
@@ -44,9 +52,18 @@
     "@babel/plugin-proposal-class-properties": "7.18.6",
     "@babel/plugin-syntax-decorators": "7.18.6",
     "@babel/plugin-proposal-decorators": "7.18.6",
-    "@embroider/addon-dev": "1.8.3",
+    "@babel/preset-typescript": "7.22.5",
+    "@babel/runtime": "^7.22.6",
+    "@embroider/addon-dev": "3.2.0",
     "@nullvoxpopuli/eslint-configs": "2.2.36",
+    "@rollup/plugin-babel": "6.0.3",
+    "@rollup/plugin-node-resolve": "15.1.0",
+    "@tsconfig/ember": "^3.0.0",
+    "@types/rsvp": "^4.0.4",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
     "concurrently": "7.2.2",
+    "ember-source": "~4.12.3",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-decorator-position": "5.0.0",
     "eslint-plugin-ember": "10.6.1",
@@ -55,10 +72,10 @@
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-simple-import-sort": "7.0.0",
-    "rollup": "2.77.0",
+    "rollup": "3.26.3",
     "babel-eslint": "10.1.0",
     "eslint": "^7.0.0",
-    "@rollup/plugin-babel": "5.3.1"
+    "typescript": "5.1.6"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -81,7 +98,7 @@
     "extends": "../package.json"
   },
   "peerDependencies": {
-    "ember-source": "^3.8 || 4"
+    "ember-source": "^3.8 || >= 4.0.0"
   },
   "release-it": {
     "plugins": {

ember-element-helper/rollup.config.js renamed to ember-element-helper/rollup.config.mjs

@@ -1,32 +1,36 @@
-import babel from '@rollup/plugin-babel';
+import { babel } from '@rollup/plugin-babel';
 import { Addon } from '@embroider/addon-dev/rollup';
+import { defineConfig } from 'rollup';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
 
 const addon = new Addon({
   srcDir: 'src',
   destDir: 'dist',
 });
 
-export default {
+const extensions = ['.js', '.ts'];
+
+export default defineConfig({
   // This provides defaults that work well alongside `publicEntrypoints` below.
   // You can augment this if you need to.
   output: addon.output(),
 
   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']),
+    addon.publicEntrypoints(['index.js', 'helpers/element.js']),
 
     // These are the modules that should get reexported into the traditional
     // "app" tree. Things in here should also be in publicEntrypoints above, but
     // not everything in publicEntrypoints necessarily needs to go here.
-    addon.appReexports([
-      'components/**/*.js',
-      'helpers/**/*.js',
-      'modifiers/**/*.js',
-      'services/**/*.js',
-      'initializers/**/*.js',
-      'instance-initializers/**/*.js',
-    ]),
+    addon.appReexports(['helpers/element.js']),
+
+    // Follow the V2 Addon rules about dependencies. Your code can import from
+    // `dependencies` and `peerDependencies` as well as standard Ember-provided
+    // package names.
+    addon.dependencies(),
+
+    nodeResolve({ extensions }),
 
     // This babel config should *not* apply presets or compile away ES modules.
     // It exists only to provide development niceties for you, like automatic
@@ -35,14 +39,10 @@ export default {
     // By default, this will load the actual babel config from the file
     // babel.config.json.
     babel({
+      extensions,
       babelHelpers: 'bundled',
     }),
 
-    // Follow the V2 Addon rules about dependencies. Your code can import from
-    // `dependencies` and `peerDependencies` as well as standard Ember-provided
-    // package names.
-    addon.dependencies(),
-
     // Ensure that standalone .hbs files are properly integrated as Javascript.
     addon.hbs(),
 
@@ -53,4 +53,4 @@ export default {
     // Remove leftover build artifacts when starting a new build.
     addon.clean(),
   ],
-};
+});

ember-element-helper/src/helpers/element.js renamed to ember-element-helper/src/helpers/element.ts

@@ -7,14 +7,24 @@ import { ensureSafeComponent } from '@embroider/util';
 
 function UNINITIALIZED() {}
 
-export default class ElementHelper extends Helper {
-  constructor() {
-    super(...arguments);
-    this.tagName = UNINITIALIZED;
-    this.componentClass = null;
-  }
+type Positional<T> = [name: T];
+type Return<T> = EmberComponent<{
+  Element: T extends keyof HTMLElementTagNameMap ? HTMLElementTagNameMap[T] : Element;
+  Blocks: { default: [] };
+}>;
+
+export interface ElementSignature<T extends string> {
+  Args: {
+    Positional: Positional<T>;
+  };
+  Return: Return<T> | undefined;
+}
+
+export default class ElementHelper<T extends string> extends Helper<ElementSignature<T>> {
+  tagName: string | (() => void) = UNINITIALIZED;
+  componentClass?: Return<T>;
 
-  compute(params, hash) {
+  compute(params: Positional<T>, hash: object) {
     assert('The `element` helper takes a single positional argument', params.length === 1);
     assert(
       'The `element` helper does not take any named arguments',
@@ -32,9 +42,9 @@ export default class ElementHelper extends Helper {
             tagName = tagName; // eslint-disable-line ember/require-tagless-components
           },
           this
-        );
+        ) as Return<T>;
       } else {
-        this.componentClass = null;
+        this.componentClass = undefined;
 
         runInDebug(() => {
           let message = 'The argument passed to the `element` helper must be a string';

ember-element-helper/src/index.js

@@ -0,0 +1,3 @@
+import ElementHelper from './helpers/element';
+
+export { ElementHelper as element };

ember-element-helper/src/index.ts

@@ -0,0 +1,17 @@
+{
+  "extends": "@tsconfig/ember/tsconfig.json",
+  "compilerOptions": {
+    "noEmit": false,
+    "emitDeclarationOnly": true,
+    "declarationDir": "./declarations",
+    "paths": {
+      "*": [
+        "./types/*"
+      ]
+    }
+  },
+  "include": [
+    "src/**/*",
+    "types/**/*"
+  ],
+}

ember-element-helper/tsconfig.json

@@ -0,0 +1,2 @@
+import 'ember-source/types';
+import 'ember-source/types/preview';