https://github.com/hugomrdias/hd-scripts

JS Configs for my repos
https://github.com/hugomrdias/hd-scripts

eslint javascript prettier typescript

Last synced: 18 days ago
JSON representation

JS Configs for my repos

• Host: GitHub
• URL: https://github.com/hugomrdias/hd-scripts
• Owner: hugomrdias
• License: mit
• Created: 2017-10-19T13:51:41.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-10T02:56:09.000Z (5 months ago)
• Last Synced: 2024-10-12T14:31:34.043Z (27 days ago)
• Topics: eslint, javascript, prettier, typescript
• Language: JavaScript
• Homepage:
• Size: 354 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • License: license

Awesome Lists containing this project

README

        
# hd-scripts [![NPM Version](https://img.shields.io/npm/v/hd-scripts.svg)](https://www.npmjs.com/package/hd-scripts) [![NPM License](https://img.shields.io/npm/l/hd-scripts.svg)](https://www.npmjs.com/package/hd-scripts) [![tests](https://github.com/hugomrdias/hd-scripts/actions/workflows/main.yml/badge.svg)](https://github.com/hugomrdias/hd-scripts/actions/workflows/main.yml)

> My personal config and scripts for projects

## Install

```bash

pnpm install hd-scripts

```

## Usage

`package.json`

```json

{

  "main": "src/index.js",

  "types": "dist/src/index.d.ts",

  "files": ["dist/src", "src", "index.js", "cli.js"],

  "scripts": {

    "lint": "eslint . && prettier --check **/*.{js,ts,yml,json} --ignore-path .gitignore && tsc"

  },

  "simple-git-hooks": {

    "pre-commit": "npx lint-staged"

  },

  "lint-staged": {

    "*.{js,ts,md,yml,json}": "prettier --write",

    "*": "eslint --fix"

  },

  "eslintConfig": {

    "extends": "./node_modules/hd-scripts/eslint/index.js",

    "ignorePatterns": ["node_modules", "coverage", "dist", "docs"],

    // for preact

    "rules": {

      "react/no-unknown-property": "off",

      "react/prop-types": "off"

    },

    "settings": {

      "react": {

        "pragma": "h",

        "version": "18.0"

      }

    }

  },

  "prettier": "hd-scripts/prettier.config.js"

}

```

`tsconfig.json`

```json

{

  "extends": "hd-scripts/tsconfig.json",

  "compilerOptions": {

    "outDir": "dist",

    "emitDeclarationOnly": true

  },

  "include": ["src", "test.js", "cli.js", "package.json"]

}

```

For typescript code bases:

```json

{

  "extends": "hd-scripts/tsconfig.json",

  "compilerOptions": {

    "outDir": "dist",

    "module": "NodeNext",

    "moduleResolution": "NodeNext"

  },

  "include": ["src", "test.js", "cli.js", "package.json"]

}

```

In monorepos you can install `hd-scripts` only in the root and extends the root `tsconfig.json` in the packages.

## License

MIT © [Hugo Dias](http://hugodias.me)