diff --git a/.github/.DS_Store b/.github/.DS_Store deleted file mode 100644 index 7a21cfbc..00000000 Binary files a/.github/.DS_Store and /dev/null differ diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 7fa2eee4..d980b3c7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -26,19 +26,66 @@ No one other than repository managers have direct access to the repository. For All new work that is to be considered for merging with the `MASTER` branch must start from a new feature branch of work. This feature branch should be in response to either a bug or a new business requirement. -#### Feature branch naming +### Feature branch naming The name of the feature branch should be descriptive as to the nature of the work and please include any references to the story or bug work item ID. +### Conventional Commits + +This project utilizes [Conventional Commits](https://www.conventionalcommits.org/) to auto-generate release verions, based on the [Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). + + +``` +[optional scope]: +``` + +All commit messages must be prefixed with a specific type so that the semver release configuration can analyze the commit and apply the correct version release. Please see the following types with their respective meanings. + +#### MAJOR + +For a MAJOR release, you MUST follow this template. The use of `perf:` and `BREAKING CHANGE:` are needed in order to push a major release. + +``` +perf(pencil): remove graphiteWidth option + +BREAKING CHANGE: The graphiteWidth option has been removed. +The default graphite width of 10mm is always used for performance reasons. +``` + +#### MINOR +``` +feat(pencil): add 'graphiteWidth' option +``` + +#### PATCH +``` +fix(pencil): stop graphite breaking when too much pressure applied +``` + +#### Other commit types + +| type | description | +|---|---| +| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) | +| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) | +| docs | Documentation only changes | +| feat | A new feature (this correlates with `MINOR` in semantic versioning) | +| fix | A bug fix (this correlates with `PATCH` in semantic versioning) | +| perf | A code change that improves performance (correlating with `MAJOR` in semantic versioning) | +| BREAKING CHANGE | A code change that is not backwards compatable (correlating with `MAJOR` in semantic versioning) | +| refactor | A code change that neither fixes a bug nor adds a feature | +| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) | +| test | Adding missing tests or correcting existing tests | + #### Git commit messages Once you have completed your feature update, please commit all changes to the branch. All commit messages should use an **imperative mood**. Imperative mood simply means _“spoken or written as if giving a command or instruction”_. A few examples are: -- Clean your room -- Close the door -- Take out the trash +* Clean your room +* Close the door +* Take out the trash A properly formed Git commit subject line should always be able to complete the following sentence: @@ -46,10 +93,24 @@ _"If applied, this commit will [your subject line here]."_ For example: -- If applied, this commit will `refactor component X for accessibility` -- If applied, this commit will `add feature Y to component X` +* If applied, this commit will `refactor component X for accessibility` +* If applied, this commit will `add feature Y to component X` + +Example messages when using Conventional Commits: + +``` +$ build: update to Gulp 4.x + +$ docs: address issue #14, typo in install instructions + +$ perf: restructure API to comply with new feature spec + +$ feat: add ability to consume large data as an array versus string + +$ fix: address issue #57 in regards to color output +``` -#### Push branch and submit pull request +### Push branch and submit pull request One you have committed new work to your feature branch, be sure to push your updates to the Github repository. Depending on your IDE or CLI configuration this may be a manual or automatic step. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f43e98a7..0b54d3e2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -12,10 +12,10 @@ _Please summarize the scope of the changes you have submitted, what the intent o Please delete options that are not relevant. -- [ ] New capability +- [ ] New capability - [ ] Revision of an existing capability - [ ] Infrastructure change (automation, etc.) -- [ ] Other (please elaborate) +- [ ] Other (please elaborate) ## Checklist: @@ -25,7 +25,7 @@ Please delete options that are not relevant. **By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.** -_Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission._ +_Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission._ **Thank you for your submission!**
--- Orion Design System Team +-- Auro Design System Team diff --git a/.gitignore b/.gitignore index caf42ebf..c160b9de 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ +.DS_Store node_modules -ods-foo +auro-test diff --git a/LICENSE b/LICENSE index 261eeb9e..845b991c 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright [year] Alaska Airlines Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/README.md b/README.md index 925959aa..a66b9a7a 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ The Design System Web Component Generator is a project tool intended to assist d It is suggested that this package be installed globally as to ensure quick and easy access to initializing new web components at will. ```shell -$ npm i @alaskaairux/ods-wc-generator -g +$ npm i @alaskaairux/wc-generator -g ``` -The ODS Web Component Generator is configured to ensure that you have the latest version of the generator prior to starting a new build project. You can also verify your installed version manually by running the following command. +The Auro Web Component Generator is configured to ensure that you have the latest version of the generator prior to starting a new build project. You can also verify your installed version manually by running the following command. ```shell -$ npm list -g @alaskaairux/ods-wc-generator +$ npm list -g @alaskaairux/wc-generator ``` ## Execute @@ -21,26 +21,30 @@ $ npm list -g @alaskaairux/ods-wc-generator The API of the npm generator is as follows: ``` -ods-wc-generate --name [wc name] --dir [your dir] +wc-generate --name [wc name] --dir [your dir] ``` #### Example ```shell -$ ods-wc-generate --name button --dir ./ods-button +$ wc-generate --name button --dir ./auro-button ``` #### API | variable | required | description | |----|----|----| -| --name | Yes | Name of the web component you wish to build. `ods` is assumed, so only the proper name, e.g. `button` or `checkbox` | -| -- dir | No | Directory where the new custom element files will be created. If a directory is not provided, one using the `--name` variable will be created | +| -h, --help | no | Get help info about WC generator | +| -t, --test | no | Test repo generation without installing dependencies | +| -n, --name [name] | yes | Name of the web component you wish to build. `auro` is assumed, so only the proper name, e.g. `button` or `checkbox` | +| -d, --dir [directory] | no | Directory where the new custom element files will be created. If a directory is not provided, one using the `--name` variable will be created | +| -v, --version | no | Ouput the version number | +| --verbose | no | Verbose command line feedback | ## General documentation -Please see [OrionStatelessComponents__docs](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs) for all information in regards to using and developing HTML custom elements with the Design System. +Please see [Auro docs](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs) for all information in regards to using and developing HTML custom elements with the Design System. ## UI development browser support @@ -48,13 +52,9 @@ For the most up to date information on UI development browser support, see [./do ## Building a Custom element -Once the new development environment has been created, there are some conventions to follow to ensure the success of your new Custom Element. Please see the development documentation [ODS Stateless Component Development Details](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TECH_DETAILS.md) +Once the new development environment has been created, there are some conventions to follow to ensure the success of your new Custom Element. Please see the development documentation [Auro Web Component Development Details](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TECH_DETAILS.md) ------- - -#### Status badges - -[![Build Status](https://travis-ci.org/AlaskaAirlines/ODS-WC-Generator.svg?branch=master)](https://travis-ci.org/AlaskaAirlines/ODS-WC-Generator) -![npm (scoped)](https://img.shields.io/npm/v/@alaskaairux/ods-wc-generator.svg?color=orange) -![NPM](https://img.shields.io/npm/l/@alaskaairux/ods-wc-generator.svg?color=blue) +[![Build Status](https://travis-ci.org/AlaskaAirlines/WC-Generator.svg?branch=master)](https://travis-ci.org/AlaskaAirlines/WC-Generator) +![npm (scoped)](https://img.shields.io/npm/v/@alaskaairux/wc-generator.svg?color=orange) +![NPM](https://img.shields.io/npm/l/@alaskaairux/wc-generator.svg?color=blue) diff --git a/bin/generate.js b/bin/generate.js index d25574d6..8aec5b35 100755 --- a/bin/generate.js +++ b/bin/generate.js @@ -42,6 +42,7 @@ const parseArgs = () => { '--verbose': Boolean, // Aliases '-h': '--help', + '-t': '--test', '-v': '--version', '-n': '--name', '-d': '--dir', @@ -59,7 +60,7 @@ const parseArgs = () => { const test = args['--test']; const name = args['--name'] || 'no-name-given'; const dir = path.resolve( - args['--dir'] || `./OrionStatelessComponents__ods-${lowerKebabCase(name)}` + args['--dir'] || `./auro-${lowerKebabCase(name)}` ); return { @@ -85,11 +86,14 @@ const formatTemplateFileContents = (content, { name }) => { const userName = require('git-user-name'); // gets git email from ./gitconfig const userEmail = require('git-user-email'); + // generate new year for copyright stamp + const newYear = new Date().getFullYear(); const replacements = [ { regex: /\[name\]/g, value: lowerKebabCaseName }, { regex: /\[Name\]/g, value: upperCamelCaseName }, { regex: /\[author\]/g, value: userName }, - { regex: /\[author-email\]/g, value: userEmail } + { regex: /\[author-email\]/g, value: userEmail }, + { regex: /\[year\]/g, value: newYear } ]; // replace all instances of [name] and [Name] accordingly @@ -159,6 +163,8 @@ const loadingLoop = condition => { const generateFromTemplate = async () => { const pjson = require('../package.json'); const latestVersion = require('latest-version'); + + // this test needs to be updates post first release of new '@alaskaairux/wc-generator' const latestPublishedVersion = await latestVersion('@alaskaairux/ods-wc-generator'); log(chalk.green(`\nPublished: v${latestPublishedVersion} | Installed: v${pjson.version}\n`)) @@ -188,14 +194,31 @@ const generateFromTemplate = async () => { log(chalk.red(` p:::::::p `)); log(chalk.red(` p:::::::p `)); log(chalk.red(` ppppppppp \n\n`)); - log(chalk.red(`\nSorry, we have to stop you here.\nIt's been detected you have v${pjson.version} installed,\nand the latest version is v${latestPublishedVersion}. Please run the following:\n\nnpm i @alaskaairux/ods-wc-generator@${latestPublishedVersion} -g\n\nfor the latest version.\n`)) + log(chalk.red(`\nSorry, we have to stop you here.\nIt's been detected you have v${pjson.version} installed,\nand the latest version is v${latestPublishedVersion}. Please run the following:\n\nnpm i @alaskaairux/wc-generator@${latestPublishedVersion} -g\n\nfor the latest version.\n`)) } else { + log(chalk.green( + ` + _____ _ _ _____ _ _ _ +| _ | |___ ___| |_ ___ | _ |_|___| |_|___ ___ ___ +| | | .'|_ -| '_| .'| | | | _| | | | -_|_ -| +|__|__|_|__,|___|_,_|__,| |__|__|_|_| |_|_|_|_|___|___| + + + _ _ _ _____ _____ _ +| | | | | | __|___ ___ ___ ___ ___| |_ ___ ___ +| | | | --| | | | -_| | -_| _| .'| _| . | _| +|_____|_____| |_____|___|_|_|___|_| |__,|_| |___|_| + + +Creating a Design System People Love. + `)) + await makeFolder(params.dir); await copyAllFiles(paths.self.template, params.dir, params, { - 'ods-[name].test.js': `ods-${lowerKebabCase(params.name)}.test.js`, - 'ods-[name].js': `ods-${lowerKebabCase(params.name)}.js`, + 'auro-[name].test.js': `auro-${lowerKebabCase(params.name)}.test.js`, + 'auro-[name].js': `auro-${lowerKebabCase(params.name)}.js`, 'package.temp': 'package.json', '.npmignore.temp': '.npmignore', '.gitignore.temp': '.gitignore', @@ -205,9 +228,32 @@ const generateFromTemplate = async () => { let areDependenciesInstalled = false; let isNodeSassRebuilt = false; + let isGitRepo = false; + let isBuilt = false; + let isPolymerInstalled = false; if (!params.test) { - process.stdout.write(`\nInstalling Dependencies`); + process.stdout.write(`\nSetting up Git`); + loadingLoop(() => isGitRepo); + try { + await exec('git init && git add . && git commit -m "initial commit"', { cwd: params.dir }); + log(chalk.green('\nGit repo successfully created')); + } catch ({ message }) { + log(chalk.red(message)); + } + isGitRepo = true; + + process.stdout.write(`\nSetting up Polymer`); + loadingLoop(() => isPolymerInstalled); + try { + await exec('npm i polymer -g', { cwd: params.dir }); + log(chalk.green('\nPolymer successfully installed globably!')); + } catch ({ message }) { + log(chalk.red(message)); + } + isPolymerInstalled = true; + + process.stdout.write(`\nInstalling dependencies`); loadingLoop(() => areDependenciesInstalled); try { await exec('npm i', { cwd: params.dir }); @@ -217,7 +263,7 @@ const generateFromTemplate = async () => { } areDependenciesInstalled = true; - process.stdout.write(`\nRebuilding node-sass`); + process.stdout.write(`\nRebuilding node-sass, ugh`); loadingLoop(() => isNodeSassRebuilt); try { await exec('npm rebuild node-sass', { cwd: params.dir }); @@ -227,38 +273,19 @@ const generateFromTemplate = async () => { } isNodeSassRebuilt = true; - log('\n') - log(' . . ') - log(' * *') - log('') - log(' * * *') - log(' !') - log(' * * ') - log('') - log(" ██████╗ ██████╗ ██╗ ██████╗ ███╗ ██╗") - log("██╔═══██╗██╔══██╗██║██╔═══██╗████╗ ██║") - log("██║ ██║██████╔╝██║██║ ██║██╔██╗ ██║") - log("██║ ██║██╔══██╗██║██║ ██║██║╚██╗██║") - log("╚██████╔╝██║ ██║██║╚██████╔╝██║ ╚████║") - log(" ╚═════╝ ╚═╝ ╚═╝╚═╝ ╚═════╝ ╚═╝ ╚═══╝") - log('') - log("██████╗ ███████╗███████╗██╗ ██████╗ ███╗ ██╗") - log("██╔══██╗██╔════╝██╔════╝██║██╔════╝ ████╗ ██║") - log("██║ ██║█████╗ ███████╗██║██║ ███╗██╔██╗ ██║") - log("██║ ██║██╔══╝ ╚════██║██║██║ ██║██║╚██╗██║") - log("██████╔╝███████╗███████║██║╚██████╔╝██║ ╚████║") - log("╚═════╝ ╚══════╝╚══════╝╚═╝ ╚═════╝ ╚═╝ ╚═══╝") - log('') - log("███████╗██╗ ██╗███████╗████████╗███████╗███╗ ███╗") - log("██╔════╝╚██╗ ██╔╝██╔════╝╚══██╔══╝██╔════╝████╗ ████║") - log("███████╗ ╚████╔╝ ███████╗ ██║ █████╗ ██╔████╔██║") - log("╚════██║ ╚██╔╝ ╚════██║ ██║ ██╔══╝ ██║╚██╔╝██║") - log("███████║ ██║ ███████║ ██║ ███████╗██║ ╚═╝ ██║") - log("╚══════╝ ╚═╝ ╚══════╝ ╚═╝ ╚══════╝╚═╝ ╚═╝") - log('\n') - log(chalk.green(`Well done! The new HTML Custom Element ods-${params.name} has been created! + process.stdout.write(`\nRunning initial component build`); + loadingLoop(() => isBuilt); + try { + await exec('npm run ciBuild', { cwd: params.dir }); + log(chalk.green('\nInitial build success!')); + } catch ({ message }) { + log(chalk.red(message)); + } + isBuilt = true; + + log(chalk.green(`Well done! The new HTML Custom Element auro-${params.name} has been created! \nDir: ${params.dir} - \nODS-WC: v${pjson.version} + \nWC: v${pjson.version} \n`)); } } diff --git a/package-lock.json b/package-lock.json index d273fff2..3ed3c7b9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { - "name": "@alaskaairux/ods-wc-generator", - "version": "1.1.1", + "name": "@alaskaairux/wc-generator", + "version": "1.1.3", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -1857,7 +1857,6 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/extend-shallow/-/extend-shallow-2.0.1.tgz", "integrity": "sha1-Ua99YUrZqfYQ6huvu5idaxxWiQ8=", - "dev": true, "requires": { "is-extendable": "^0.1.0" } @@ -1934,8 +1933,7 @@ "fs-exists-sync": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/fs-exists-sync/-/fs-exists-sync-0.1.0.tgz", - "integrity": "sha1-mC1ok6+RjnLQjeyehnP/K1qNat0=", - "dev": true + "integrity": "sha1-mC1ok6+RjnLQjeyehnP/K1qNat0=" }, "fs-extra": { "version": "8.1.0", @@ -1984,7 +1982,6 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/git-config-path/-/git-config-path-1.0.1.tgz", "integrity": "sha1-bTP37WPbDQ4RgTFQO6s6ykfVRmQ=", - "dev": true, "requires": { "extend-shallow": "^2.0.1", "fs-exists-sync": "^0.1.0", @@ -2042,7 +2039,6 @@ "git-user-email": { "version": "git://github.com/codejamninja/git-user-email.git#5997c83689085f47c8bdaf0eb1da5b2192fb997d", "from": "git://github.com/codejamninja/git-user-email.git#npm", - "dev": true, "requires": { "extend-shallow": "^2.0.1", "git-config-path": "^1.0.1", @@ -2053,7 +2049,6 @@ "version": "2.0.0", "resolved": "https://registry.npmjs.org/git-user-name/-/git-user-name-2.0.0.tgz", "integrity": "sha512-1DC8rUNm2I5V9v4eIpK6PSjKCp9bI0t6Wl05WSk+xEMS8GhR8GWzxM3aGZfPrfuqEfWxSbui5/pQJryJFXqCzQ==", - "dev": true, "requires": { "extend-shallow": "^2.0.1", "git-config-path": "^1.0.1", @@ -2169,7 +2164,6 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/homedir-polyfill/-/homedir-polyfill-1.0.3.tgz", "integrity": "sha512-eSmmWE5bZTK2Nou4g0AI3zZ9rswp7GRKoKXS1BLUkvPviOqs4YTN1djQIqrXy9k5gEtdLPy86JjRwsNM9tnDcA==", - "dev": true, "requires": { "parse-passwd": "^1.0.0" } @@ -2365,8 +2359,7 @@ "is-extendable": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/is-extendable/-/is-extendable-0.1.1.tgz", - "integrity": "sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik=", - "dev": true + "integrity": "sha1-YrEQ4omkcUGOPsNqYX1HLjAd/Ik=" }, "is-extglob": { "version": "2.1.1", @@ -6672,7 +6665,6 @@ "version": "1.1.1", "resolved": "https://registry.npmjs.org/parse-git-config/-/parse-git-config-1.1.1.tgz", "integrity": "sha1-06mYQxcTL1c5hxK7pDjhKVkN34w=", - "dev": true, "requires": { "extend-shallow": "^2.0.1", "fs-exists-sync": "^0.1.0", @@ -6693,8 +6685,7 @@ "parse-passwd": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/parse-passwd/-/parse-passwd-1.0.0.tgz", - "integrity": "sha1-bVuTSkVpk7I9N/QKOC1vFmao5cY=", - "dev": true + "integrity": "sha1-bVuTSkVpk7I9N/QKOC1vFmao5cY=" }, "path-exists": { "version": "3.0.0", diff --git a/package.json b/package.json index c75bec34..3c4608ad 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "@alaskaairux/ods-wc-generator", + "name": "@alaskaairux/wc-generator", "version": "1.1.3", - "description": "Boilerplate generator for Orion Design Components", + "description": "Boilerplate generator for Auro Web Components", "main": "index.js", "files": [ "bin", @@ -9,11 +9,11 @@ "util" ], "bin": { - "ods-wc-generate": "./bin/generate.js" + "wc-generate": "./bin/generate.js" }, "repository": { "type": "git", - "url": "git+https://github.com/AlaskaAirlines/ODS-WC-Generator.git" + "url": "git+https://github.com/AlaskaAirlines/WC-Generator.git" }, "author": "AlaskaAirlines", "license": "Apache-2.0", @@ -21,9 +21,9 @@ "node": ">=11.11" }, "bugs": { - "url": "https://github.com/AlaskaAirlines/ODS-WC-Generator/issues" + "url": "https://github.com/AlaskaAirlines/WC-Generator/issues" }, - "homepage": "https://github.com/AlaskaAirlines/ODS-WC-Generator#readme", + "homepage": "https://github.com/AlaskaAirlines/WC-Generator#readme", "dependencies": { "arg": "^4.1.3", "chalk": "^3.0.0", @@ -53,9 +53,9 @@ ] }, "scripts": { - "testbuild": "node bin/generate.js --test --name foo --dir ./ods-foo", - "sweep": "rm -rf ods-foo", - "blanktest": "echo \"Error: no test specified\" && exit 0", + "testbuild": "node bin/generate.js -t -n solo -d ./auro-test", + "fullbuild": "node bin/generate.js -n solo -d ../auro-test", + "sweep": "rm -rf auro-test", "test": "npm run testbuild" }, "publishConfig": { @@ -73,7 +73,8 @@ ], "keywords": [ "alaska airlines", - "orion design system", + "auro", + "design system", "web components", "generator" ], diff --git a/template/.DS_Store b/template/.DS_Store deleted file mode 100644 index 9c7e095a..00000000 Binary files a/template/.DS_Store and /dev/null differ diff --git a/template/.github/PULL_REQUEST_TEMPLATE.md b/template/.github/PULL_REQUEST_TEMPLATE.md index f43e98a7..0b54d3e2 100644 --- a/template/.github/PULL_REQUEST_TEMPLATE.md +++ b/template/.github/PULL_REQUEST_TEMPLATE.md @@ -12,10 +12,10 @@ _Please summarize the scope of the changes you have submitted, what the intent o Please delete options that are not relevant. -- [ ] New capability +- [ ] New capability - [ ] Revision of an existing capability - [ ] Infrastructure change (automation, etc.) -- [ ] Other (please elaborate) +- [ ] Other (please elaborate) ## Checklist: @@ -25,7 +25,7 @@ Please delete options that are not relevant. **By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.** -_Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission._ +_Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission._ **Thank you for your submission!**
--- Orion Design System Team +-- Auro Design System Team diff --git a/template/.travis.temp b/template/.travis.temp index 8e6e6015..26ac5cdc 100644 --- a/template/.travis.temp +++ b/template/.travis.temp @@ -14,7 +14,7 @@ notifactions: before_script: - npm run buildTokens - - npm run processSrc + - npm run processSrc - npm run distTokens - npm run sassRender - npm run distJS diff --git a/template/NOTICE b/template/NOTICE index 5bffaa6d..79aaf1ce 100644 --- a/template/NOTICE +++ b/template/NOTICE @@ -1,2 +1,2 @@ -Alaska Airlines Orion Design System -Copyright 2019 Alaska Airlines, Inc. or its affiliates. All Rights Reserved. +Alaska Airlines Auro Design System +Copyright [year] Alaska Airlines, Inc. or its affiliates. All Rights Reserved. diff --git a/template/README.md b/template/README.md index 7f5d0698..6bf498cf 100644 --- a/template/README.md +++ b/template/README.md @@ -1,16 +1,10 @@ -Orion Design System Logo +## Element auro-[name] -[![Build Status](https://travis-ci.org/AlaskaAirlines/OrionStatelessComponents__ods-[name].svg?branch=master)](https://travis-ci.org/AlaskaAirlines/OrionStatelessComponents__ods-[name]) -![npm (scoped)](https://img.shields.io/npm/v/@alaskaairux/ods-[name].svg?color=orange) -![NPM](https://img.shields.io/npm/l/@alaskaairux/ods-[name].svg?color=blue) - -# \ - -\ is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of ... +`` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of ... ## Docs -All information regarding Project Setup, Technical Details, Tests and information regarding ODS Stateless Components can be found in the [docs](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/tree/master/src) project repository. +All information regarding Project Setup, Technical Details, Tests and information regarding Auro Stateless Components can be found in the [docs](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/tree/master/src) project repository. ## UI development browser support @@ -19,35 +13,35 @@ For the most up to date information on UI development browser support, see [docs ## Install ```shell -$ npm i @alaskaairux/ods-[name] +$ npm i @alaskaairux/auro-[name] ``` 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. ### Design Token CSS Custom Property dependency -The use of any ODS custom element has a dependency on the [ODS Design Tokens](https://github.com/AlaskaAirlines/OrionDesignTokens). +The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://github.com/AlaskaAirlines/OrionDesignTokens). -For additional details in regards to using Orion Design Tokens with components, please see [docs/TECH_DETAILS.md](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TECH_DETAILS.md) +For additional details in regards to using Auro Design Tokens with components, please see [docs/TECH_DETAILS.md](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TECH_DETAILS.md) ### CSS Custom Property fallbacks [CSS custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) are [not supported](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/CUSTOM_PROPERTIES.md) in older browsers. For this, fallback properties are pre-generated and included with the npm. -Any update to the Orion Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties. +Any update to the Auro Design Tokens will be immediately reflected with browsers that support CSS custom properties, legacy browsers will require updated components with pre-generated fallback properties. ### Define dependency in project component -Defining the component dependency within each component that is using the \ component. +Defining the component dependency within each component that is using the `` component. ```javascript -import "@alaskaairux/ods-[name]"; +import "@alaskaairux/auro-[name]"; ``` **Reference component in HTML** ```html -Hello World +Hello World ``` ## Styling (experimental) @@ -64,7 +58,7 @@ See [caniuse.com](https://caniuse.com/#search=%3A%3Apart) for more information. ## [name] use cases -The \ element should be used in situations where users may: +The `` element should be used in situations where users may: * ... * ... @@ -78,10 +72,10 @@ The \ element should be used in situations where users may: ## API Code Examples -Default [name] +Default auro-[name] ```html -Hello World +Hello World ``` ### [React] Custom callbacks @@ -91,16 +85,9 @@ Default [name] [name](React support) with `ref` for passing in an event, [see notes](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/CALLBACK.md). ```html -hello world +hello world ``` -## Alternate build solutions - -Why would you need this? With all Orion custom elements the CSS for the element is embedded within the shadow DOM of the custom element. If your development environment is not allowing for the use of shadow DOM elements, the CSS for each element is distributed via additional resources within the npm package. - -[Read more about how to use alternate CSS build resources](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/ALT_BUILD.md) - - ## Development 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. @@ -111,10 +98,10 @@ Please be sure to review the [contribution guidelines](https://github.com/Alaska Once the project has been cloned to your local resource and you have installed all the dependencies you will need to open three different shell sessions. One is for the **Gulp tasks**, the second is for a series of **npm tasks** and the last is to run the **Polymer server**. -**Peer dependency:** Please make sure Polymer is installed globally in order to run the Polymer server. See [ODS Stateless Component Development Details](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TECH_DETAILS.md) for more information. +**Peer dependency:** Please make sure Polymer is installed globally in order to run the Polymer server. See [Auro Stateless Component Development Details](https://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TECH_DETAILS.md) for more information. ```bash -$ npm i polymer-cli +$ npm i polymer-cli -g ``` ```shell @@ -129,11 +116,10 @@ polymer serve ``` ### Testing -Automated tests are required for every Orion component. See `.\test\ods-[name].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://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TESTS.md) for more details. +Automated tests are required for every Auro component. See `.\test\auro-[name].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://github.com/AlaskaAirlines/OrionStatelessComponents__docs/blob/master/src/TESTS.md) for more details. +------ -## -
-Alaska Airlines Orion Design System
-Copyright 2019 Alaska Airlines, Inc. or its affiliates. All Rights Reserved. -
+[![Build Status](https://travis-ci.org/AlaskaAirlines/OrionStatelessComponents__auro-[name].svg?branch=master)](https://travis-ci.org/AlaskaAirlines/OrionStatelessComponents__auro-[name]) +![npm (scoped)](https://img.shields.io/npm/v/@alaskaairux/auro-[name].svg?color=orange) +![NPM](https://img.shields.io/npm/l/@alaskaairux/auro-[name].svg?color=blue) diff --git a/template/demo/index.html b/template/demo/index.html index 56e7fb96..e256fd49 100644 --- a/template/demo/index.html +++ b/template/demo/index.html @@ -6,13 +6,13 @@ name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes" /> - Orion Design System | ods-[name] element + Auro Design System | auro-[name] element - +