A typescript language service plugin that gives superpowers to SQL tagged template literals. Specifically aimed at the MySQL syntax.
npm install ts-mysql-pluginA typescript language service plugin that gives superpowers to SQL tagged template literals. Specifically aimed at the MySQL syntax.
- Autocomplete for MySQL keywords
- Autocomplete for table names and column names (powered by your schema)
- Hover documentation for MySQL keywords
- Hover documentation for tables and columns (powered by your schema)
- Diagnostics for MySQL syntax errors
- Diagnostics for invalid table names and column names (powered by your schema)
- Diagnostics for invalid column types (powered by your schema)
- Works in all major editors (VSCode, Sublime Text, Atom, etc.)
Step 1: Yarn.
``sh`
yarn add --dev ts-mysql-plugin
Step 2: TS Config.
Add the plugin to your compiler options in tsconfig.json. Note that databaseUri is optional, but recommended.
`json`
{
"compilerOptions": {
"plugins": [
{
"name": "ts-mysql-plugin",
"databaseUri": "mysql://USER@HOST/DB_NAME"
}
]
}
}
You can also optionally override the default tags ("SQL" and "sql") by adding a "tags" array to the config. For example, if you want the plugin to activate only on "Sql" tags:
`json`
{
"name": "ts-mysql-plugin",
"tags": ["Sql"]
}
If you add @ts-mysql-plugin ignore in a comment at the top of a file, then the plugin will skip the file.
Run the following:
`shell`
yarn install
yarn build
Assuming you've run all the steps in the "Development" section, then run the following:
`shell`
cd e2e
yarn install
docker-compose up -d
cd ..
yarn test
We use np to cut and publish new releases. Run the following:
`shell``
yarn run pub