Skip to content

Commit 2b145b6

Browse files
committed
chore: update dependencies and configs
AlaskaAirlines/auro-cli#91
1 parent 84122be commit 2b145b6

File tree

8 files changed

+368
-4105
lines changed

8 files changed

+368
-4105
lines changed

.commitlintrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["@aurodesignsystem/auro-config/commitlint"]
3+
}

.lintstagedrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["@aurodesignsystem/auro-config/lintstaged"]
3+
}

README.md

Lines changed: 16 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ The README.md file is a compiled document. No edits should be made directly to t
44
README.md is created by running `npm run build:docs`.
55
66
This file is generated based on a template fetched from
7-
`https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_updated_paths.md`
8-
and copied to `./componentDocs/README.md` each time the the docs are compiled.
7+
`https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/README.md`
8+
and copied to `./componentDocs/README.md` each time the docs are compiled.
99
1010
The following sections are editable by making changes to the following files:
1111
@@ -34,14 +34,14 @@ The `<auro-skeleton>` element uses animation to convey that the page is still lo
3434

3535
## UI development browser support
3636

37-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
37+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/browserSupport.md) -->
3838
For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
3939

4040
<!-- AURO-GENERATED-CONTENT:END -->
4141

4242
## Install
4343

44-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) -->
44+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentInstall.md) -->
4545
[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-skeleton/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-skeleton/actions/workflows/testPublish.yml)
4646
[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-skeleton?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-skeleton)
4747
[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-skeleton?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
@@ -51,24 +51,22 @@ For the most up to date information on [UI development browser support](https://
5151
$ npm i @aurodesignsystem/auro-skeleton
5252
```
5353

54-
Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.
55-
5654
<!-- AURO-GENERATED-CONTENT:END -->
5755

5856
### Design Token CSS Custom Property dependency
5957

60-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
58+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/designTokens.md) -->
6159
The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
6260

6361
<!-- AURO-GENERATED-CONTENT:END -->
6462

6563
### Define dependency in project component
6664

67-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) -->
65+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImportDescription.md) -->
6866
Defining the component dependency within each component that is using the `<auro-skeleton>` component.
6967

7068
<!-- AURO-GENERATED-CONTENT:END -->
71-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) -->
69+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/componentImport.md) -->
7270

7371
```js
7472
import "@aurodesignsystem/auro-skeleton";
@@ -86,23 +84,13 @@ import "@aurodesignsystem/auro-skeleton";
8684
```
8785
<!-- AURO-GENERATED-CONTENT:END -->
8886

89-
## Install bundled assets from CDN
90-
91-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) -->
92-
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-skeleton__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
93-
94-
**WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.
87+
## Use CDN
9588

96-
<!-- AURO-GENERATED-CONTENT:END -->
97-
98-
### Bundle example code
89+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/usage/bundleInstallDescription.md) -->
90+
In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
9991

100-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) -->
101-
10292
```html
103-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@/dist/auro-classic/CSSCustomProperties.css" />
104-
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@/dist/bundled/essentials.css" />
105-
<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/[email protected]/dist/auro-skeleton__bundled.js" type="module"></script>
93+
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-skeleton@latest/+esm"></script>
10694
```
10795

10896
<!-- AURO-GENERATED-CONTENT:END -->
@@ -130,7 +118,7 @@ The `<auro-skeleton>` element can be used on container-based components like `<a
130118

131119
## Development
132120

133-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/developmentDescription.md) -->
121+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/developmentDescription.md) -->
134122
In order to develop against this project, if you are not part of the core team, you will be required to fork the project prior to submitting a pull request.
135123

136124
Please be sure to review the [contribution guidelines](https://auro.alaskaair.com/contributing) for this project. Please make sure to **pay special attention** to the **conventional commits** section of the document.
@@ -139,42 +127,20 @@ Please be sure to review the [contribution guidelines](https://auro.alaskaair.co
139127

140128
### Start development environment
141129

142-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/localhost.md) -->
130+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/localhost.md) -->
143131
Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open a shell session to run the **dev server**.
144132

145133
```shell
146134
$ npm run dev
147135
```
148136

149-
Open [localhost:8000](http://localhost:8000/)
150-
151-
If running separate sessions is preferred, please run the following commands in individual terminal shells.
152-
153-
```shell
154-
$ npm run build:watch
155-
156-
$ npm run serve
157-
```
158-
159-
<!-- AURO-GENERATED-CONTENT:END -->
137+
Open [localhost:8000](http://localhost:8000/)
160138

161-
### API generation
162-
163-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/api.md) -->
164-
The custom element API file is generated in the build and committed back to the repo with a version change. If the API doc has changed without a version change, author's are to run `npm run build:api` to generate the doc and commit to version control.
165-
166139
<!-- AURO-GENERATED-CONTENT:END -->
167140

168141
### Testing
169142

170-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
171-
Automated tests are required for every Auro component. See `.\test\auro-skeleton.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
172-
173-
<!-- AURO-GENERATED-CONTENT:END -->
174-
175-
### Bundled assets
176-
177-
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/bundles.md) -->
178-
Bundled assets are only generated in the remote and not merged back to this repo. To review and/or test a bundled asset locally, run `$ npm run bundler` to generate assets.
143+
<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/auro-templates/main/templates/default/partials/development/testing.md) -->
144+
Automated tests are required for every Auro component. See `.\test\auro-skeleton.test.js` for the tests for this component. Run `npm run test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
179145

180146
<!-- AURO-GENERATED-CONTENT:END -->

commitlint.config.cjs

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)