https://github.com/goldziher/sqlfluff-js

SQLFluff wrapper in node
https://github.com/goldziher/sqlfluff-js

Last synced: 29 days ago
JSON representation

SQLFluff wrapper in node

• Host: GitHub
• URL: https://github.com/goldziher/sqlfluff-js
• Owner: Goldziher
• Created: 2024-08-04T17:23:44.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-04T18:48:36.000Z (6 months ago)
• Last Synced: 2024-11-01T14:42:49.396Z (3 months ago)
• Language: JavaScript
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SQLFluff Node

## Local Development

- run with node 20 or above in the shell (use [nvm](https://github.com/nvm-sh/nvm) to manage node versions)

1. Run `npm install` to install dependencies.

Optionally:

    - Lint and format using `npm run lint` and `npm run format` respectively.

2. Install the CLI globally with

```bash

    npm install -g .

```

This will expose the command `sqlfluffjs`  in the shell. The name of the command is set in [package.json](./package.json) under the `bin` key.

## To publish the package

1. Login to NPM using `npm login`

2. Update the version in `package.json` (`npm version patch` etc. also work)

3. Update the package.json file as required: version, links, author, description, license, etc.

4. Update the README.md file as required.

5. Update the name of the command in the `bin` key in `package.json` if required.

6. Run `npm publish`.

Its suggested to start with a version that includes `@alpha` or `@beta` to indicate that the package is not stable yet and allow some testing.