Skip to content

Commit

Permalink
Sync with embroider-addon blueprint
Browse files Browse the repository at this point in the history
  • Loading branch information
SergeAstapov committed Dec 27, 2023
1 parent 9dc1789 commit 66d1456
Show file tree
Hide file tree
Showing 22 changed files with 6,361 additions and 2,859 deletions.
17 changes: 13 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
# you definitely want this:
node_modules
# See https://help.github.com/ignore-files/ for more about ignoring files.

# and you can put in anything else that tends to accumulate in your environment:
# dependencies
node_modules/

# *.md copies from release
/addon/README.md
/addon/LICENSE.md

# misc
.env*
.eslintcache
.pnp*
.pnpm-debug.log
coverage/
.DS_Store
yarn-error.log
9 changes: 9 additions & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Docs: https://pnpm.io/npmrc
# https://github.com/emberjs/rfcs/pull/907

# we don't want addons to be bad citizens of the ecosystem
auto-install-peers=false

# we want true isolation,
# if a dependency is not declared, we want an error
resolve-peers-from-workspace-root=false
1 change: 0 additions & 1 deletion CHANGELOG.md

This file was deleted.

26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

## v1.0.0 (2022-03-18)

#### :boom: Breaking Change
* [#90](https://github.com/ember-animation/ember-animated-tools/pull/90) Convert to v2 addon ([@SergeAstapov](https://github.com/SergeAstapov))
* [#87](https://github.com/ember-animation/ember-animated-tools/pull/87) Octanify addon setup; drops support for pre-Octane versions of Ember ([@SergeAstapov](https://github.com/SergeAstapov))

#### :memo: Documentation
* [#100](https://github.com/ember-animation/ember-animated-tools/pull/100) Bump ember-animated to v1 and update docs around using pnpm ([@SergeAstapov](https://github.com/SergeAstapov))
* [#97](https://github.com/ember-animation/ember-animated-tools/pull/97) Update minimum supported version ([@SergeAstapov](https://github.com/SergeAstapov))

#### :house: Internal
* [#99](https://github.com/ember-animation/ember-animated-tools/pull/99) Add `publishConfig.registry` to addon/package.json ([@SergeAstapov](https://github.com/SergeAstapov))
* [#94](https://github.com/ember-animation/ember-animated-tools/pull/94) Run `npx ember-cli-update --to=v4.2.0` to align with the latest blueprint ([@SergeAstapov](https://github.com/SergeAstapov))
* [#88](https://github.com/ember-animation/ember-animated-tools/pull/88) Update ember-animate-docs path ([@SergeAstapov](https://github.com/SergeAstapov))
* [#86](https://github.com/ember-animation/ember-animated-tools/pull/86) Ember cli update ([@SergeAstapov](https://github.com/SergeAstapov))
* [#85](https://github.com/ember-animation/ember-animated-tools/pull/85) Bump `ember-animated` ([@SergeAstapov](https://github.com/SergeAstapov))

#### Committers: 1
- Sergey Astapov ([@SergeAstapov](https://github.com/SergeAstapov))

# 0.5.0

- BREAKING: Drop Node older than 12
- No API changes
- HOUSEKEEPING: many internals updates by @SergeAstapov for full compatibility with Ember 4 and Embroider
36 changes: 21 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,39 @@
# How To Contribute

This repo is divided into multiple packages using pnpm workspaces:

- `addon` is the actual ember-animated-tools addon
- `test-app` is its test suite

## Installation

* `git clone https://github.com/ember-animation/ember-animated-tools.git`
* `cd ember-animated-tools`
* `pnpm install`
- `git clone https://github.com/ember-animation/ember-animated-tools.git`
- `cd ember-animated-tools`
- `pnpm install`

## Linting

Inside any of the packages you can run:
- `pnpm lint`
- `pnpm lint:fix`

## Building the addon

* `pnpm lint`
* `pnpm lint:fix`
- `cd addon`
- `pnpm build`

## Running tests

* `cd addon && pnpm run start` – Builds the addon in "watch mode" so changes picked up by test app.
* `cd test-app && ember test` – Runs the test suite on the current Ember version
* `cd test-app && ember test --server` – Runs the test suite in "watch mode"
* `cd test-app && ember try:each` – Runs the test suite against multiple Ember versions
- `cd addon && pnpm start` – Builds the addon in "watch mode" so changes picked up by test app.
- `cd test-app && ember test` – Runs the test suite on the current Ember version
- `cd test-app && ember test --server` – Runs the test suite in "watch mode"
- `cd test-app && ember try:each` – Runs the test suite against multiple Ember versions

During development, if you'd like test app to pick up changes in the addon, make sure to run both
`cd addon && pnpm start` and `cd test-app && ember test --server` in different terminals.

## Running the dummy application
## Running the test application

* `cd addon && pnpm run start` – Builds the addon in "watch mode" so changes picked up by the docs app.
* `cd test-app && ember serve`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
- `cd test-app && ember serve`
- Visit the test application at [http://localhost:4200](http://localhost:4200).

For more information on using ember-cli, visit [https://ember-cli.com/](https://ember-cli.com/).
For more information on using ember-cli, visit [https://cli.emberjs.com/release/](https://cli.emberjs.com/release/).
1 change: 0 additions & 1 deletion README.md

This file was deleted.

46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Ember Animated Tools

A widget useful for slowing down and debugging Ember Animated animations.


Compatibility
------------------------------------------------------------------------------

- Ember.js v4.8 or above
- Embroider or ember-auto-import v2

Installation
------------------------------------------------------------------------------

```
ember install ember-animated-tools
```

Usage
------------------------------------------------------------------------------

Add the slideable widget:

```hbs
<AnimatedTools />
```

Or add it, but keep it hidden until a hotkey reveals it:

```hbs
<AnimatedTools @hideUntilKeys="Ctrl-Shift-KeyA" />
```

Or if you want to use the lower-level pieces, you can directly place the `<MotionIndicator />` or `<TimeControl />` components wherever you like.


Contributing
------------------------------------------------------------------------------

See the [Contributing](CONTRIBUTING.md) guide for details.


License
------------------------------------------------------------------------------

This project is licensed under the [MIT License](LICENSE.md).
19 changes: 12 additions & 7 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ Once the prep work is completed, the actual release is straight forward:

* First, ensure that you have installed your projects dependencies:

```sh
pnpm install
```
```sh
pnpm install
```

* Second, ensure that you have obtained a
[GitHub personal access token][generate-token] with the `repo` scope (no
Expand All @@ -45,16 +45,21 @@ pnpm install
export GITHUB_AUTH=abc123def456
```

[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable

* And last (but not least 😁) do your release.

```sh
pnpm run release-it
```
```sh
pnpm release
```

[release-it](https://github.com/release-it/release-it/) manages the actual
release process. It will prompt you to choose the version number after which
you will have the chance to hand tweak the changelog to be used (for the
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
pushing the tag and commits, etc.

## Unstable Tag

For every push to the master branch, [`push-dist`](./.github/workflows/push-dist.yml)
places the compiled assets on a "dist" branch.
14 changes: 1 addition & 13 deletions addon/.eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,10 @@

# compiled output
/dist/
/tmp/

# dependencies
/bower_components/
/node_modules/
/declarations/

# misc
/coverage/
!.*
.*/
.eslintcache

# ember-try
/.node_modules.ember-try/
/bower.json.ember-try
/npm-shrinkwrap.json.ember-try
/package.json.ember-try
/package-lock.json.ember-try
/yarn.lock.ember-try
28 changes: 9 additions & 19 deletions addon/.eslintrc.js → addon/.eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ module.exports = {
root: true,
parser: '@babel/eslint-parser',
parserOptions: {
ecmaVersion: 2021,
ecmaVersion: 'latest',
sourceType: 'module',
ecmaFeatures: {
legacyDecorators: true,
babelOptions: {
root: __dirname,
},
},
plugins: ['ember'],
Expand All @@ -26,15 +26,10 @@ module.exports = {
// node files
{
files: [
'./.eslintrc.js',
'./.prettierrc.js',
'./.template-lintrc.js',
'./addon-main.js',
'./ember-cli-build.js',
'./testem.js',
'./blueprints/*/index.js',
'./config/**/*.js',
'./tests/dummy/config/**/*.js',
'./.eslintrc.cjs',
'./.prettierrc.cjs',
'./.template-lintrc.cjs',
'./addon-main.cjs',
],
parserOptions: {
sourceType: 'script',
Expand All @@ -43,13 +38,8 @@ module.exports = {
browser: false,
node: true,
},
plugins: ['node'],
extends: ['plugin:node/recommended'],
},
{
// test files
files: ['tests/**/*-test.{js,ts}'],
extends: ['plugin:qunit/recommended'],
plugins: ['n'],
extends: ['plugin:n/recommended'],
},
],
};
2 changes: 2 additions & 0 deletions addon/.lint-todo
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
add|ember-template-lint|require-presentational-children|3|4|3|4|c031d6d6560ea079d5b4754914054601e9dfdbc8|1644883200000|1647471600000|1650063600000|src/components/animated-tools.hbs
remove|ember-template-lint|require-presentational-children|3|4|3|4|c031d6d6560ea079d5b4754914054601e9dfdbc8|1644883200000|1647471600000|1650063600000|src/components/animated-tools.hbs
add|ember-template-lint|require-presentational-children|4|6|4|6|9ef138d564105bcd0db3daa6ade55165f5e0e5ee|1703635200000|1706227200000|1708819200000|src/components/animated-tools.hbs
14 changes: 0 additions & 14 deletions addon/.npmignore

This file was deleted.

7 changes: 1 addition & 6 deletions addon/.prettierignore
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
# unconventional js
/blueprints/*/files/
/vendor/

# compiled output
/dist/
/tmp/

# dependencies
/node_modules/
/declarations/

# misc
/coverage/
!.*
.eslintcache
.lint-todo/

# Prettier does not support @task(function () {}).restartable() modifier
Expand Down
1 change: 1 addition & 0 deletions addon/.prettierrc.js → addon/.prettierrc.cjs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';

module.exports = {
plugins: ['prettier-plugin-ember-template-tag'],
singleQuote: true,
};
File renamed without changes.
26 changes: 0 additions & 26 deletions addon/CHANGELOG.md

This file was deleted.

Loading

0 comments on commit 66d1456

Please sign in to comment.