https://github.com/nihalgonsalves/node-typescript-eslint-template

TypeScript template repository with typescript-eslint (airbnb config) and ts-node-dev + Dockerfile / GitHub Workflow
https://github.com/nihalgonsalves/node-typescript-eslint-template

boilerplate eslint github-actions minimal template typescript

Last synced: 10 days ago
JSON representation

TypeScript template repository with typescript-eslint (airbnb config) and ts-node-dev + Dockerfile / GitHub Workflow

• Host: GitHub
• URL: https://github.com/nihalgonsalves/node-typescript-eslint-template
• Owner: nihalgonsalves
• License: cc0-1.0
• Created: 2019-08-28T09:14:00.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-22T11:34:13.000Z (7 months ago)
• Last Synced: 2024-04-22T12:51:22.420Z (7 months ago)
• Topics: boilerplate, eslint, github-actions, minimal, template, typescript
• Language: Dockerfile
• Homepage:
• Size: 1.45 MB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-typescript-eslint-template

![build status](https://github.com/nihalgonsalves/node-typescript-eslint-template/workflows/build/badge.svg)

![last commit](https://img.shields.io/github/last-commit/nihalgonsalves/node-typescript-eslint-template)

![license UNLICENSE](https://img.shields.io/github/license/nihalgonsalves/node-typescript-eslint-template?color=brightgreen)

TypeScript template repository with typescript-eslint (airbnb config) and ts-node-dev.

Dependabot keeps the dependencies up to date.

- **Build tool**: yarn (can be replaced with npm: `rm yarn.lock && npm install`)

- **Target Node version**: 18.x (es2023)

- **Structure**: `src/` for TypeScript source files and `build/` for output

- Also includes a default `.editorconfig` with 2-space indents

Scripts:

- `yarn dev` run from source, auto-restarting

- `yarn lint` run eslint

- `yarn lint --fix` run eslint with auto-formatting

- `yarn build` build to JS

- `yarn start` run built JS

- `yarn test` currently does nothing

## use with react

```diff

diff --git a/.eslintrc b/.eslintrc

index e755856..bbaeee5 100644

--- a/.eslintrc

+++ b/.eslintrc

@@ -1,3 +1,6 @@

{

-  "extends": ["./node_modules/@nihalgonsalves/esconfig/.eslintrc"]

+  "extends": [

+    "./node_modules/@nihalgonsalves/esconfig/.eslintrc",

+    "./node_modules/@nihalgonsalves/esconfig/.eslintrc.react"

+  ]

}

```