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

feat(npm-keywords): Add keywords to components package.json files #237

Merged
merged 10 commits into from
Feb 7, 2017
12 changes: 12 additions & 0 deletions docs/authoring-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,18 @@ Additionally, all new components require the following within their `package.jso

This is needed so that lerna will be able to automatically publish new scoped packages.

We also require a list of keywords for each package. This list should always include `material components` and `material design`, followed by the component name:

```
"keywords": {
"material components",
"material design",
<COMPONENT_NAME>
}
```

For example, if you are building a checkbox component, `keywords` would include `material components`, `material design`, and `checkbox`

### License Stanzas

We are required to put the following at the _top_ of _every source code file_, including tests,
Expand Down
4 changes: 4 additions & 0 deletions packages/material-components-web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
"description": "Modular and customizable Material Design UI components for the web",
"version": "0.4.0",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-animation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "Animation Variables and Mixins used by Material Components for the web",
"version": "0.1.3",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"animation"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-button/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web button component",
"version": "0.2.1",
"license": "Apache 2.0",
"keywords": [
"material components",
"material design",
"button"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-card/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"version": "0.1.3",
"description": "The Material Components for the web card component",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"card"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-checkbox/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web checkbox component",
"version": "0.2.0",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"checkbox"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-drawer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"version": "0.1.3",
"description": "The Material Components Web drawer component",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"navigation",
"drawer"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-elevation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "Material Components for the web mixins + CSS Classes for Material Design elevation",
"version": "0.1.2",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"elevation"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-fab/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"description": "The Material Components for the web floating action button component",
"version": "0.3.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"floating action button",
"fab"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-form-field/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "Material Components for the web wrapper styles for laying out form fields and labels next to one another",
"version": "0.1.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"form"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-icon-toggle/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
"version": "0.1.3",
"main": "index.js",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"icon toggle"
],
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-layout-grid/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"version": "0.1.0",
"description": "The Material Components for the web layout grid component",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"grid",
"layout"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-list/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web list component",
"version": "0.2.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"list"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-menu/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"version": "0.1.2",
"description": "The Material Components for the web menu component",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"menu"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-radio/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web radio component",
"version": "0.1.3",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"radio"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-ripple/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web Ink Ripple effect for web element interactions",
"version": "0.2.0",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"ripple"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-rtl/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"description": "Material Components for the web RTL Scss helpers",
"version": "0.1.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"rtl",
"right to left"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-select/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"description": "The Material Components web select (textfield drop-down) component",
"version": "0.2.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"select",
"multi select"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-snackbar/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web snackbar component",
"version": "0.1.3",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"snackbar"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-switch/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web switch component",
"version": "0.1.0",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"switch"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-textfield/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web text field component",
"version": "0.2.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"textfield"
],
"main": "index.js",
"repository": {
"type": "git",
Expand Down
5 changes: 5 additions & 0 deletions packages/mdc-theme/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"description": "The Material Components for the web theming system",
"version": "0.1.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"theme"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down
6 changes: 6 additions & 0 deletions packages/mdc-typography/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"description": "Typography classes, mixins, and variables for Material Components for the web",
"version": "0.1.1",
"license": "Apache-2.0",
"keywords": [
"material components",
"material design",
"typography",
"font"
],
"repository": {
"type": "git",
"url": "https://github.com/material-components/material-components-web.git"
Expand Down