Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jweyrich/generator-mssql-types
A Yeoman code generator that inspects your Stored Procedures and generates strongly typed TypeScript code for them.
https://github.com/jweyrich/generator-mssql-types
code-generator mssql sql-server stored-procedures typescript yeoman-generator
Last synced: about 2 months ago
JSON representation
A Yeoman code generator that inspects your Stored Procedures and generates strongly typed TypeScript code for them.
- Host: GitHub
- URL: https://github.com/jweyrich/generator-mssql-types
- Owner: jweyrich
- License: mit
- Created: 2022-06-18T02:39:09.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-07-14T19:09:49.000Z (over 2 years ago)
- Last Synced: 2024-10-12T09:07:58.746Z (3 months ago)
- Topics: code-generator, mssql, sql-server, stored-procedures, typescript, yeoman-generator
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/generator-mssql-types
- Size: 23.4 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-mssql-types
[](https://badge.fury.io/js/generator-mssql-types) [](https://travis-ci.org/jweyrich/generator-mssql-types)
A Yeoman code generator that inspects your Stored Procedures and generates strongly typed TypeScript code for them.
Currently supports only Microsoft SQL Server.
You can customize the templates according to your needs. See [templates](src/generators/app/templates/) for references.
## What it does
See the description above :-)
## How to install
```sh
yarn global add yo generator-mssql-types
# or
npm install -g yo generator-mssql-types
```
## How to run
You have 2 options to run the generator.
### 1. Run using an `.env` file
Have an `.env` file containing the following:
```bash
DB_CONNECTION_STRING=mssql://username:password@localhost/DATABASE_NAME
```
Then just run:
```bash
yo mssql-types
```
### 2. Run manually specifying environment variables
```bash
DB_CONNECTION_STRING=mssql://username:password@localhost/DATABASE_NAME yo mssql-types
```
## Arguments & Options
Here's the `--help` output:
```bash
Usage:
yo mssql-types:app [] [options]
Options:
-h, --help # Print the generator's options and usage
--skip-cache # Do not remember prompt answers Default: false
--skip-install # Do not automatically install dependencies Default: false
--force-install # Fail on install dependencies error Default: false
--ask-answered # Show prompts for already configured options Default: false
Arguments:
templatesDirectory Type: String Required: false
```
### templatesDirectory
You can specify an alternative template directory. Example:
```bash
yo mssql-types ./my-templates
```
## TODO
- Discover whether a stored procedure parameter has a default value or not. It's currently not possible without parsing the procedure definition. For more information see https://docs.microsoft.com/en-us/sql/relational-databases/system-catalog-views/sys-parameters-transact-sql?view=sql-server-ver16