https://github.com/nullvoxpopuli/project-linter
Create conventions for file placement for any kind of JS/TS project. React, Angular, Vue, Svelte, Ember, etc.
https://github.com/nullvoxpopuli/project-linter
Last synced: over 1 year ago
JSON representation
Create conventions for file placement for any kind of JS/TS project. React, Angular, Vue, Svelte, Ember, etc.
- Host: GitHub
- URL: https://github.com/nullvoxpopuli/project-linter
- Owner: NullVoxPopuli
- Created: 2020-06-15T00:39:54.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T08:54:25.000Z (over 3 years ago)
- Last Synced: 2025-03-30T01:01:35.838Z (over 1 year ago)
- Language: TypeScript
- Size: 976 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project Linter
Define a schema for enforcing structure within your project.
Enforce consistency while trying to figure out what works best for your team.
This works by using Abstract Syntax Trees (ASTs) to identify file types,
defined by you, categorize them, and then validation their location against
the schema.
## Install
```bash
npm install project-linter
# or
yarn add project-linter
```
## Usage
```js
// .project-lintrc.js
module.exports = {
categories: {
componentJs: require('./...)
component: ['single-file-component', 'multi-file-component']
componentFolder: {
}
}
}
```