diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 97f2a69..9e547db 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -16,6 +16,11 @@ jobs: lint: name: Lint runs-on: ubuntu-latest + strategy: + matrix: + package-location: + - 'ember-render-helpers' + - 'test-app' timeout-minutes: 5 steps: - name: Check out a copy of the repo @@ -37,10 +42,16 @@ jobs: - name: Lint run: pnpm lint + working-directory: ${{ matrix.package-location }} test: name: Test runs-on: ubuntu-latest + strategy: + matrix: + package-location: + - 'ember-render-helpers' + - 'test-app' timeout-minutes: 5 steps: - name: Check out a copy of the repo @@ -62,6 +73,7 @@ jobs: - name: Test run: pnpm test + working-directory: ${{ matrix.package-location }} test-compatibility: name: Test compatibility @@ -99,3 +111,4 @@ jobs: - name: Test run: pnpm test:ember-compatibility ${{ matrix.scenario }} --- pnpm test + working-directory: 'test-app' diff --git a/.gitignore b/.gitignore index 66712ac..e291d36 100644 --- a/.gitignore +++ b/.gitignore @@ -1,34 +1,8 @@ -# See https://help.github.com/ignore-files/ for more about ignoring files. - -# compiled output -/dist/ -/tmp/ - # dependencies -/node_modules/ +node_modules/ # misc -/.env* -/.pnp* -/.DS_Store -/.sass-cache -/.eslintcache -/.stylelintcache -/connect.lock -/coverage/ -/libpeerconnection.log -/npm-debug.log* -/testem.log -/yarn-error.log - -# ember-try -/.node_modules.ember-try/ -/bower.json.ember-try -/npm-shrinkwrap.json.ember-try -/package.json.ember-try -/package-lock.json.ember-try -/pnpm-lock.yaml.ember-try -/yarn.lock.ember-try - -# broccoli-debug -/DEBUG/ +.DS_Store +.env* +.eslintcache +.pnpm-debug.log diff --git a/LICENSE.md b/LICENSE.md index f8d1edb..ff84a5b 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2019 +Copyright (c) 2024 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: diff --git a/app/helpers/did-insert-helper.js b/app/helpers/did-insert-helper.js deleted file mode 100644 index c889502..0000000 --- a/app/helpers/did-insert-helper.js +++ /dev/null @@ -1 +0,0 @@ -export { default } from 'ember-render-helpers/helpers/did-insert-helper'; diff --git a/app/helpers/did-update-helper.js b/app/helpers/did-update-helper.js deleted file mode 100644 index bb2ab6a..0000000 --- a/app/helpers/did-update-helper.js +++ /dev/null @@ -1 +0,0 @@ -export { default } from 'ember-render-helpers/helpers/did-update-helper'; diff --git a/app/helpers/will-destroy-helper.js b/app/helpers/will-destroy-helper.js deleted file mode 100644 index 0812958..0000000 --- a/app/helpers/will-destroy-helper.js +++ /dev/null @@ -1 +0,0 @@ -export { default } from 'ember-render-helpers/helpers/will-destroy-helper'; diff --git a/ember-cli-build.js b/ember-cli-build.js deleted file mode 100644 index f925770..0000000 --- a/ember-cli-build.js +++ /dev/null @@ -1,25 +0,0 @@ -'use strict'; - -const { maybeEmbroider } = require('@embroider/test-setup'); -const EmberAddon = require('ember-cli/lib/broccoli/ember-addon'); - -module.exports = function (defaults) { - const app = new EmberAddon(defaults, { - // 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 - */ - - return maybeEmbroider(app, { - skipBabel: [ - { - package: 'qunit', - }, - ], - }); -}; diff --git a/ember-render-helpers/.eslintignore b/ember-render-helpers/.eslintignore new file mode 100644 index 0000000..3336de0 --- /dev/null +++ b/ember-render-helpers/.eslintignore @@ -0,0 +1,12 @@ +# unconventional js +/blueprints/*/files/ + +# compiled output +/declarations/ +/dist/ + +# misc +/coverage/ +!.* +.*/ + diff --git a/ember-render-helpers/.eslintrc.js b/ember-render-helpers/.eslintrc.js new file mode 100644 index 0000000..1069ceb --- /dev/null +++ b/ember-render-helpers/.eslintrc.js @@ -0,0 +1,74 @@ +'use strict'; + +module.exports = { + root: true, + parser: '@typescript-eslint/parser', + parserOptions: { + ecmaVersion: 'latest', + sourceType: 'module', + }, + plugins: [ + 'ember', + '@typescript-eslint', + 'simple-import-sort', + 'typescript-sort-keys', + ], + extends: [ + 'eslint:recommended', + 'plugin:ember/recommended', + 'plugin:import/recommended', + 'plugin:import/typescript', + 'plugin:prettier/recommended', + 'plugin:typescript-sort-keys/recommended', + ], + env: { + browser: true, + }, + rules: { + curly: 'error', + 'simple-import-sort/exports': 'error', + 'simple-import-sort/imports': 'error', + }, + settings: { + 'import/resolver': { + node: { + extensions: ['.gjs', '.gts', '.js', '.ts'], + }, + typescript: true, + }, + }, + overrides: [ + // TypeScript and JavaScript files + { + files: ['**/*.{gjs,gts,js,ts}'], + extends: [ + 'plugin:@typescript-eslint/eslint-recommended', + 'plugin:@typescript-eslint/recommended', + ], + rules: { + 'import/no-duplicates': 'error', + 'import/no-unresolved': [ + 'error', + { ignore: ['^@ember', '^dummy/', '^ember', 'fetch'] }, + ], + }, + }, + // Node files (v2 addon) + { + files: [ + './.eslintrc.js', + './.prettierrc.js', + './.stylelintrc.js', + './.template-lintrc.js', + './addon-main.cjs', + './blueprints/*/index.js', + './rollup.config.mjs', + ], + env: { + browser: false, + node: true, + }, + extends: ['plugin:n/recommended'], + }, + ], +}; diff --git a/ember-render-helpers/.gitignore b/ember-render-helpers/.gitignore new file mode 100644 index 0000000..708b76e --- /dev/null +++ b/ember-render-helpers/.gitignore @@ -0,0 +1,12 @@ +# compiled output +/declarations/ +/dist/ + +# dependencies +/node_modules/ + +# misc +/.eslintcache + +# npm/pnpm/yarn pack output +*.tgz diff --git a/ember-render-helpers/.prettierignore b/ember-render-helpers/.prettierignore new file mode 100644 index 0000000..b0381f9 --- /dev/null +++ b/ember-render-helpers/.prettierignore @@ -0,0 +1,9 @@ +# unconventional js +/blueprints/*/files/ + +# compiled output +/declarations/ +/dist/ + +# misc +/coverage/ diff --git a/.prettierrc.js b/ember-render-helpers/.prettierrc.js similarity index 100% rename from .prettierrc.js rename to ember-render-helpers/.prettierrc.js diff --git a/ember-render-helpers/.template-lintrc.js b/ember-render-helpers/.template-lintrc.js new file mode 100644 index 0000000..d05a35d --- /dev/null +++ b/ember-render-helpers/.template-lintrc.js @@ -0,0 +1,6 @@ +'use strict'; + +module.exports = { + plugins: ['ember-template-lint-plugin-prettier'], + extends: ['recommended', 'ember-template-lint-plugin-prettier:recommended'], +}; diff --git a/ember-render-helpers/LICENSE.md b/ember-render-helpers/LICENSE.md new file mode 100644 index 0000000..ff84a5b --- /dev/null +++ b/ember-render-helpers/LICENSE.md @@ -0,0 +1,9 @@ +The MIT License (MIT) + +Copyright (c) 2024 + +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. diff --git a/ember-render-helpers/README.md b/ember-render-helpers/README.md new file mode 100644 index 0000000..3164f2a --- /dev/null +++ b/ember-render-helpers/README.md @@ -0,0 +1,156 @@ +# ember-render-helpers + +![CI](https://github.com/buschtoens/ember-render-helpers/workflows/CI/badge.svg) +[![npm version](https://badge.fury.io/js/ember-render-helpers.svg)](http://badge.fury.io/js/ember-render-helpers) +[![Download Total](https://img.shields.io/npm/dt/ember-render-helpers.svg)](http://badge.fury.io/js/ember-render-helpers) +[![Ember Observer Score](https://emberobserver.com/badges/ember-render-helpers.svg)](https://emberobserver.com/addons/ember-render-helpers) +[![Ember Versions](https://img.shields.io/badge/Ember.js%20Versions-%5E3.8-brightgreen.svg)](https://travis-ci.org/buschtoens/ember-render-helpers) +[![ember-cli Versions](https://img.shields.io/badge/ember--cli%20Versions-%5E2.13%20%7C%7C%20%5E3.0-brightgreen.svg)](https://travis-ci.org/buschtoens/ember-render-helpers) +[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) +[![dependencies](https://img.shields.io/david/buschtoens/ember-render-helpers.svg)](https://david-dm.org/buschtoens/ember-render-helpers) +[![devDependencies](https://img.shields.io/david/dev/buschtoens/ember-render-helpers.svg)](https://david-dm.org/buschtoens/ember-render-helpers) + +Use the `{{did-insert}}`, `{{did-update}}`, `{{will-destroy}}` modifiers from [`@ember/render-modifiers`][render-modifiers] as template helpers. + +The original idea came from [this Pre-RFC][pre-rfc]. + +[render-modifiers]: https://github.com/emberjs/ember-render-modifiers#readme +[pre-rfc]: https://github.com/emberjs/rfcs/issues/484 + +## Installation + +``` +ember install ember-render-helpers +``` + +
+ +Use Glint or <template> tag? ✨ + +- Update your template registry to extend this addon's. Check the [Glint documentation](https://typed-ember.gitbook.io/glint/using-glint/ember/using-addons#using-glint-enabled-addons) for more information. + + ```ts + import '@glint/environment-ember-loose'; + + import type EmberRenderHelpersRegistry from 'ember-render-helpers/template-registry'; + + declare module '@glint/environment-ember-loose/registry' { + export default interface Registry extends EmberRenderHelpersRegistry, /* other addon registries */ { + // local entries + } + } + ``` + +- In a `