Skip to content
This repository was archived by the owner on Jun 29, 2025. It is now read-only.

Commit b2e7310

Browse files
authored
V1 (#1)
* Add tests * Create index.js * Update package.json * Update README.md * Update README.md
1 parent 426aa09 commit b2e7310

File tree

8 files changed

+6624
-1
lines changed

8 files changed

+6624
-1
lines changed

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Change Log
2+
All notable changes to this project will be documented in this file.
3+
This project adheres to [Semantic Versioning](http://semver.org/).
4+
5+
## [Unreleased]
6+
### Added
7+
8+
### Changed
9+
10+
### Fixed
11+
12+
### Removed
13+
14+
15+
## [1.0.0] - 2019-08-05
16+
17+
* Added [`vue/require-direct-export`](https://eslint.vuejs.org/rules/require-direct-export.html)
18+
* Added [`vue/no-empty-pattern`](https://eslint.vuejs.org/rules/no-empty-pattern.html)
19+
* Added [`vue/no-deprecated-scope-attribute`](https://eslint.vuejs.org/rules/no-deprecated-scope-attribute.html)
20+
* Added [`vue/no-boolean-default`](https://eslint.vuejs.org/rules/no-boolean-default.html)
21+
* Added [`vue/match-component-file-name`](https://eslint.vuejs.org/rules/match-component-file-name.html)
22+
* Added [`vue/component-name-in-template-casing`](https://eslint.vuejs.org/rules/component-name-in-template-casing.html)

CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing
2+
3+
## System Dependencies
4+
5+
### Node
6+
7+
* [Node.js](https://nodejs.org/) - v8.0.0+
8+
* [npm](https://www.npmjs.com/) - v6.0.0+
9+
10+
## Install project dependencies
11+
12+
### Code
13+
14+
* Fork and clone the eslint-config-vue-tc repo
15+
16+
### Install project dependencies
17+
18+
`npm install`
19+
20+
This installs dependencies from `package.json`.
21+
22+
### Run the build locally
23+
24+
`npm run lint`
25+
26+
This will:
27+
28+
* run linters (npmpackagejsonlint and eslint)
29+
30+
`npm test`
31+
32+
This will:
33+
34+
* run all of the jest tests
35+
36+
## Code guidelines
37+
38+
### JavaScript
39+
eslint-config-vue-tc utilizes both ESLint to enforce JavaScript standards. Please see the `.eslintrc.json` file for config.
40+
41+
* [eslint](https://github.com/eslint/eslint)
42+
43+
### Checking coding style
44+
Run `npm run lint` before committing to ensure your changes follow our coding standards.
45+
46+
## Versioning
47+
Please use the following commands to increment the version number
48+
Ex: Assume current version is 0.0.1
49+
50+
`npm --no-git-tag-version version patch`
51+
52+
If you run this command the version will increase the patch number (ie 0.0.2)
53+
54+
`npm --no-git-tag-version version minor`
55+
56+
If you run this command the version will increase the minor number (ie 0.1.0)
57+
58+
`npm --no-git-tag-version version major`
59+
60+
If you run this command the version will increase the major number (ie 1.0.0)
61+
62+
## EditorConfig
63+
EditorConfig helps maintain consistent file formatting between different editors and developers. Please [install the plugin for you editor of choice](http://editorconfig.org/#download). Please see the `.editorconfig` file at the root of this repo to see what settings are enforced.
64+
65+
## License
66+
67+
Contributions to eslint-config-vue-tc are subject to the [MIT License](https://github.com/tclindner/eslint-config-vue-tc/blob/master/LICENSE).

README.md

100644100755
Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,71 @@
11
# eslint-config-vue-tc
2-
ESLint shareable config for Vue projects
2+
3+
> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for Vue projects
4+
5+
[![license](https://img.shields.io/github/license/tclindner/eslint-config-vue-tc.svg?maxAge=2592000&style=flat-square)](https://github.com/tclindner/eslint-config-vue-tc/blob/master/LICENSE)
6+
[![npm](https://img.shields.io/npm/v/eslint-config-vue-tc.svg?maxAge=2592000?style=flat-square)](https://www.npmjs.com/package/eslint-config-vue-tc)
7+
[![CircleCI](https://circleci.com/gh/tclindner/eslint-config-vue-tc.svg?style=svg&circle-token=bd4b177e9f9299133593bd134f769a3ad4a8a841)](https://circleci.com/gh/tclindner/eslint-config-vue-tc)
8+
[![Dependency Status](https://david-dm.org/tclindner/eslint-config-vue-tc.svg?style=flat-square)](https://david-dm.org/tclindner/eslint-config-vue-tc)
9+
[![devDependency Status](https://david-dm.org/tclindner/eslint-config-vue-tc/dev-status.svg?style=flat-square)](https://david-dm.org/tclindner/eslint-config-vue-tc#info=devDependencies)
10+
11+
## What is eslint-config-vue-tc?
12+
13+
Shared configuration for ESLint. Follow the instructions below to easily include this configuration in another project without having to duplicate the file!
14+
15+
# How do I install it?
16+
17+
First thing first, let's make sure you have the necessary pre-requisites.
18+
19+
### System Dependencies
20+
21+
#### Node
22+
23+
* [Node.js](https://nodejs.org/) - v8.0.0+
24+
* [npm](http://npmjs.com) - v6.0.0+
25+
26+
### Command
27+
28+
```bash
29+
npx install-peerdeps --dev eslint-config-vue-tc
30+
```
31+
32+
> eslint and eslint-plugin-vue are peer dependencies and must be installed.
33+
34+
**This module works best when paired with [`eslint-config-tc`](https://github.com/tclindner/eslint-config-tc). Please follow it's install instructions.**
35+
36+
## Usage
37+
38+
Add the following to your `.eslintrc.json` file:
39+
40+
```json
41+
{
42+
"extends": "eslint-config-vue-tc"
43+
}
44+
```
45+
46+
If you need to override a rule, your `.eslintrc.json` file should look like the example below. All shared rules will be used, but `vue/require-direct-export` will be turned off.
47+
48+
```json
49+
{
50+
"extends": "eslint-config-vue-tc",
51+
"rules": {
52+
"vue/require-direct-export": "off"
53+
}
54+
}
55+
```
56+
57+
## Related
58+
59+
- [eslint-config-tc](https://github.com/tclindner/eslint-config-tc) - ESLint shareable config for JavaScript projects
60+
61+
## Contributing
62+
63+
Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
64+
65+
## Change Log
66+
67+
Please see the [CHANGELOG.md](CHANGELOG.md) for more information.
68+
69+
## License
70+
71+
Copyright (c) 2019 Thomas Lindner. Licensed under the MIT license.

index.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
const vue = require.resolve('./rules/vue');
2+
3+
module.exports = {
4+
extends: ['plugin:vue/recommended', vue],
5+
parserOptions: {
6+
parser: 'babel-eslint'
7+
},
8+
plugins: ['vue'],
9+
env: {
10+
es6: true
11+
}
12+
};

0 commit comments

Comments
 (0)