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(config): make config packages public #6695

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
51 changes: 51 additions & 0 deletions config/eslint-config-carbon/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# eslint-config-carbon

> ESLint configuration for Carbon

## Getting started

To install `eslint-config-carbon` in your project, you will need to run the
following command using [npm](https://www.npmjs.com/):

```bash
npm install -S eslint-config-carbon
```

If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
instead:

```bash
yarn add eslint-config-carbon
```

## Usage

You can use `eslint-config-carbon` in your project by extending it in your
`eslint` configuration. For example, if we had an `.eslintrc` file:

```json
{
"extends": ["carbon"]
}
```

The default configuration available under `eslint-config-carbon` includes all
ESLint configuration and plugins, including plugins for React.js development. If
you'd like to not include these rules in your setup, you can also include a
`base` or `vanilla` oriented configuration by doing the following:

```json
{
"extends": ["eslint-config-carbon/base"]
}
```

## 🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features,
or help us improve the project documentation. If you're interested, definitely
check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀

## 📝 License

Licensed under the [Apache 2.0 License](/LICENSE).
4 changes: 2 additions & 2 deletions config/eslint-config-carbon/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "eslint-config-carbon",
"private": true,
"version": "2.4.0-rc.0",
"description": "ESLint configuration for Carbon",
"version": "2.0.0",
"license": "Apache-2.0",
"main": "index.js",
"repository": "https://github.com/carbon-design-system/carbon/tree/master/config/eslint-config-carbon",
Expand Down
2 changes: 1 addition & 1 deletion config/stylelint-config-carbon/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# stylelint-config-carbon

> Stylelint configuration for the Carbon Design System
> Stylelint configuration for Carbon

## Getting started

Expand Down
5 changes: 2 additions & 3 deletions config/stylelint-config-carbon/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"name": "stylelint-config-carbon",
"private": true,
"description": "Stylelint configuration for the Carbon Design System",
"version": "0.4.0",
"description": "Stylelint configuration for Carbon",
"version": "1.0.0",
"license": "Apache-2.0",
"main": "index.js",
"repository": "https://github.com/carbon-design-system/carbon/tree/master/config/stylelint-config-carbon",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@
},
"eslintConfig": {
"extends": [
"eslint-config-carbon"
"carbon"
]
},
"stylelint": {
Expand Down