-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
96bb2ac
commit 6fb317c
Showing
4 changed files
with
47 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,37 @@ | ||
# marzee-tools | ||
# @marzee/eslint | ||
|
||
> A set of tools commonly used at marzee | ||
> Ready-to-use ESLint configuration for Next.js/TypeScript projects | ||
background details relevant to understanding what this module does | ||
`@marzee/eslint` provides a set of opinionated ESLint configurations for Next.js/TypeScript projects. | ||
|
||
## Usage | ||
|
||
```js | ||
var marzeeTools = require('marzee-tools') | ||
/** @type {import("eslint").Linter.Config} */ | ||
const config = { | ||
extends: [ | ||
'@marzee/eslint/next', | ||
], | ||
}; | ||
|
||
console.log('hello warld') | ||
``` | ||
|
||
outputs | ||
|
||
``` | ||
hello warld | ||
``` | ||
|
||
## API | ||
export default config; | ||
|
||
```js | ||
var marzeeTools = require('marzee-tools') | ||
``` | ||
|
||
See [api_formatting.md](api_formatting.md) for tips. | ||
|
||
## Install | ||
|
||
With [npm](https://npmjs.org/) installed, run | ||
|
||
``` | ||
$ npm install marzee-tools | ||
```sh | ||
npm i -D @marzee/eslint | ||
``` | ||
|
||
## Acknowledgments | ||
|
||
marzee-tools was inspired by.. | ||
|
||
## See Also | ||
```sh | ||
pnpm i -D @marzee/eslint | ||
``` | ||
|
||
- [`noffle/common-readme`](https://github.com/noffle/common-readme) | ||
- ... | ||
```sh | ||
yarn add -D @marzee/eslint | ||
``` | ||
|
||
## License | ||
|
||
ISC | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,39 @@ | ||
# marzee-tools | ||
# @marzee/tsconfig | ||
|
||
> A set of tools commonly used at marzee | ||
> A TSconfig with the latest best practices | ||
background details relevant to understanding what this module does | ||
`@marzee/tsconfig` provides an opinionated TSconfig with the latest best practices for both Next and Node projects. | ||
|
||
## Usage | ||
|
||
```js | ||
var marzeeTools = require('marzee-tools') | ||
### Next.js | ||
|
||
console.log('hello warld') | ||
```json | ||
{ | ||
"extends": "@marzee/tsconfig/next", | ||
// the rest of your config here | ||
} | ||
``` | ||
|
||
outputs | ||
### Node | ||
|
||
``` | ||
hello warld | ||
``` | ||
|
||
## API | ||
|
||
```js | ||
var marzeeTools = require('marzee-tools') | ||
```json | ||
{ | ||
"extends": "@marzee/tsconfig/node", | ||
// the rest of your config here | ||
} | ||
``` | ||
|
||
See [api_formatting.md](api_formatting.md) for tips. | ||
|
||
## Install | ||
|
||
With [npm](https://npmjs.org/) installed, run | ||
|
||
``` | ||
$ npm install marzee-tools | ||
```sh | ||
npm i -D @marzee/tsconfig | ||
``` | ||
|
||
## Acknowledgments | ||
|
||
marzee-tools was inspired by.. | ||
|
||
## See Also | ||
|
||
- [`noffle/common-readme`](https://github.com/noffle/common-readme) | ||
- ... | ||
|
||
## License | ||
|
||
ISC | ||
```sh | ||
pnpm i -D @marzee/tsconfig | ||
``` | ||
|
||
```sh | ||
yarn add -D @marzee/tsconfig | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters