Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade Ember to v4.12 #18

Merged
merged 3 commits into from
Apr 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .ember-cli
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,11 @@

Setting `disableAnalytics` to true will prevent any data from being sent.
*/
"disableAnalytics": false
"disableAnalytics": false,

/**
Setting `isTypeScriptProject` to true will force the blueprint generators to generate TypeScript
rather than JavaScript by default, when a TypeScript version of a given blueprint is available.
*/
"isTypeScriptProject": false
}
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@
# 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
44 changes: 23 additions & 21 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@

module.exports = {
root: true,
parser: 'babel-eslint',
parser: '@babel/eslint-parser',
parserOptions: {
ecmaVersion: 2018,
ecmaVersion: 'latest',
sourceType: 'module',
ecmaFeatures: {
legacyDecorators: true,
requireConfigFile: false,
babelOptions: {
plugins: [
['@babel/plugin-proposal-decorators', { decoratorsBeforeExport: true }],
],
},
},
plugins: ['ember'],
Expand All @@ -24,21 +27,16 @@ module.exports = {
// node files
{
files: [
'.eslintrc.js',
'.prettierrc.js',
'.template-lintrc.js',
'ember-cli-build.js',
'index.js',
'testem.js',
'blueprints/*/index.js',
'config/**/*.js',
'tests/dummy/config/**/*.js',
],
excludedFiles: [
'addon/**',
'addon-test-support/**',
'app/**',
'tests/dummy/app/**',
'./.eslintrc.js',
'./.prettierrc.js',
'./.stylelintrc.js',
'./.template-lintrc.js',
'./ember-cli-build.js',
'./index.js',
'./testem.js',
'./blueprints/*/index.js',
'./config/**/*.js',
'./tests/dummy/config/**/*.js',
],
parserOptions: {
sourceType: 'script',
Expand All @@ -47,8 +45,12 @@ module.exports = {
browser: false,
node: true,
},
plugins: ['node'],
extends: ['plugin:node/recommended'],
extends: ['plugin:n/recommended'],
},
{
// test files
files: ['tests/**/*-test.{js,ts}'],
extends: ['plugin:qunit/recommended'],
},
],
};
31 changes: 11 additions & 20 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,14 @@
#$ browsers:
#$ - chrome
#$ emberTryScenarios:
#$ - scenario: ember-lts-3.16
#$ allowedToFail: false
#$ - scenario: ember-lts-3.20
#$ - scenario: ember-lts-3.28
#$ allowedToFail: false
#$ - scenario: ember-release
#$ allowedToFail: false
#$ - scenario: ember-beta
#$ allowedToFail: false
#$ - scenario: ember-canary
#$ allowedToFail: true
#$ - scenario: ember-default-with-jquery
#$ allowedToFail: false
#$ - scenario: ember-classic
#$ allowedToFail: false
#$ nodeVersion: 10.x
#$ packageManager: yarn
#
Expand Down Expand Up @@ -83,7 +77,6 @@ jobs:
- name: Lint
run: yarn lint


test:
name: Tests
runs-on: ${{ matrix.os }}
Expand Down Expand Up @@ -128,7 +121,6 @@ jobs:
- name: Test
run: yarn test:ember --launch ${{ matrix.browser }}


floating-dependencies:
name: Floating Dependencies
runs-on: ${{ matrix.os }}
Expand Down Expand Up @@ -169,7 +161,6 @@ jobs:
- name: Test
run: yarn test:ember --launch ${{ matrix.browser }}


try-scenarios:
name: Tests - ${{ matrix.ember-try-scenario }}
runs-on: ubuntu-latest
Expand All @@ -179,16 +170,16 @@ jobs:
strategy:
fail-fast: true
matrix:
ember-try-scenario: [
ember-lts-3.16,
ember-lts-3.20,
ember-release,
ember-beta,
ember-default-with-jquery,
ember-classic,
embroider-safe,
embroider-optimized
]
ember-try-scenario:
[
ember-lts-3.28,
ember-lts-4.4,
ember-lts-4.8,
ember-release,
ember-beta,
embroider-safe,
embroider-optimized,
]
allow-failure: [false]
include:
- ember-try-scenario: ember-canary
Expand Down
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,10 @@
# 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

# broccoli-debug
/DEBUG/
8 changes: 7 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,26 @@
/.eslintignore
/.eslintrc.js
/.git/
/.github/
/.gitignore
/.prettierignore
/.prettierrc.js
/.template-lintrc.js
/.travis.yml
/.watchmanconfig
/bower.json
/config/ember-try.js
/CONTRIBUTING.md
/ember-cli-build.js
/testem.js
/tests/
/yarn-error.log
/yarn.lock
.gitkeep

# 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
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,12 @@
/coverage/
!.*
.eslintcache
.lint-todo/

# 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
9 changes: 8 additions & 1 deletion .prettierrc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
'use strict';

module.exports = {
singleQuote: true,
overrides: [
{
files: '*.{js,ts,yml}',
options: {
singleQuote: true,
},
},
],
};
2 changes: 1 addition & 1 deletion .template-lintrc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
'use strict';

module.exports = {
extends: 'octane',
extends: 'recommended',
};
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@

## Linting

* `yarn lint:hbs`
* `yarn lint:js`
* `yarn lint:js --fix`
* `yarn lint`
* `yarn lint:fix`

## Running tests

Expand All @@ -23,4 +22,4 @@
* `ember serve`
* Visit the dummy 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/).
55 changes: 27 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
![ember-prismic-dom-illustration](https://user-images.githubusercontent.com/12345/189907218-ff8a7d4e-e5bf-4d6f-af87-972ceb98195e.svg)

ember-prismic-dom
==============================================================================
# ember-prismic-dom

![CI](https://github.com/qonto/ember-prismic-dom/workflows/CI/badge.svg)
[![Latest NPM release][npm-badge]][npm-badge-url]
Expand All @@ -15,24 +14,19 @@ Easy [Prismic](https://prismic.io/) rendering in [Ember.js](https://emberjs.com)
<Prismic::Dom @nodes={{@prismicData}} />
```

Compatibility
------------------------------------------------------------------------------
## Compatibility

* Ember.js v3.16 or above
* Ember CLI v2.13 or above
* Node.js v10 or above
- Ember.js v4.4 or above
- Ember CLI v4.4 or above
- Node.js v14 or above
anas7asia marked this conversation as resolved.
Show resolved Hide resolved


Installation
------------------------------------------------------------------------------
## Installation

```sh
ember install ember-prismic-dom
```


Usage
------------------------------------------------------------------------------
## Usage

```hbs
<Prismic::Dom @nodes={{@myPrismicDoc.data.myRichText}} />
Expand All @@ -43,16 +37,19 @@ Usage
Additionaly you can pass an `onUnknownTag` action to handle recieving data of a type `Prismic::Dom` can't render.

```hbs
<Prismic::Dom @nodes={{@myPrismicDoc.data.myRichText}} @onUnknownTag={{this.onUnknownTag}} />
<Prismic::Dom
@nodes={{@myPrismicDoc.data.myRichText}}
@onUnknownTag={{this.onUnknownTag}}
/>
```

```js
import Component from '@glimmer/component';
import { action } from '@ember/object';
import Component from "@glimmer/component";
import { action } from "@ember/object";

export default class MyComponent extends Component {
@action
onUnknownTag (node) {
onUnknownTag(node) {
console.error(`Could not render ${node.type}`);
}
}
Expand All @@ -64,19 +61,21 @@ Pass a custom component name to be used to render a prismic type. For example to

```hbs
<Prismic::Dom
@group-list-item='my-list'
@hyperlink='my-hyperlink'
@group-list-item="my-list"
@hyperlink="my-hyperlink"
@nodes={{@myPrismicDoc.data.myRichText}}
/>
```

_my-list.hbs_

```hbs
<h1>My List</h2>
<ul>{{yield}}<ul>
```

_my-hyperlink.hbs_

```hbs
<a href={{@node.element.data.url}}>{{yield}}</a>
```
Expand All @@ -90,22 +89,24 @@ For example you want to use [`ember-async-image`](https://github.com/html-next/e
```

_image.hbs_

```hbs
<AsyncImage src={{@node.element.url}}/>
<AsyncImage src={{@node.element.url}} />
```

### Migrating from prismic-dom

`<Primcic::Dom/>` replaces [`prismic-dom`](https://github.com/prismicio/prismic-dom) , please [see the blog post for more information.](https://medium.com/qonto-way/introducing-ember-prismic-dom-c362647037d7)

In place of:

```js
import Component from '@glimmer/component';
import PrismicDOM from 'prismic-dom';
import Component from "@glimmer/component";
import PrismicDOM from "prismic-dom";

export default class MyComponent extends Component {
get html() {
return PrismicDOM.RichText.asHtml(this.args.myPrismicDoc.data.myRichText)
return PrismicDOM.RichText.asHtml(this.args.myPrismicDoc.data.myRichText);
}
}
```
Expand All @@ -115,17 +116,15 @@ export default class MyComponent extends Component {
```

Use this:

```hbs
<Prismic::Dom @nodes={{@myPrismicDoc.data.myRichText}} />
```

Contributing
------------------------------------------------------------------------------
## Contributing

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


License
------------------------------------------------------------------------------
## License

This project is licensed under the [MIT License](LICENSE.md).
Loading