diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 5bf9c49..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,58 +0,0 @@ -# Changelog - -## [1.2.1](https://github.com/ScopeSV/kyseline/compare/v1.2.0...v1.2.1) (2023-10-26) - - -### Bug Fixes - -* determine which filetype to use ([5e1e1fc](https://github.com/ScopeSV/kyseline/commit/5e1e1fcd8e965d50ac0b1bdc4d168c3b18657216)) - -## [1.2.0](https://github.com/ScopeSV/kyseline/compare/v1.1.2...v1.2.0) (2023-10-26) - - -### Features - -* add release please ([5370215](https://github.com/ScopeSV/kyseline/commit/5370215f788bd494891ddfd62452356cc06d2865)) -* proper depend ([37d581f](https://github.com/ScopeSV/kyseline/commit/37d581fc7335ed547ec5f50c8c159b2b54bc1790)) -* test ([8f2dcc8](https://github.com/ScopeSV/kyseline/commit/8f2dcc81168486acc8431b2fd937823267670300)) - - -### Bug Fixes - -* more renaming ([f0cf64e](https://github.com/ScopeSV/kyseline/commit/f0cf64e5b71e3d86aab9788eb479e0865c4b4419)) -* proper build run ([80ec25b](https://github.com/ScopeSV/kyseline/commit/80ec25b6f0043c034efd817662c54f092c783506)) -* remove dep ([1650a1c](https://github.com/ScopeSV/kyseline/commit/1650a1c307e22d0cda522032325b47e55b14339c)) -* rename package ([be30f34](https://github.com/ScopeSV/kyseline/commit/be30f34e19488697c93fdea2323790f226f6281b)) -* typo in package name ([8003678](https://github.com/ScopeSV/kyseline/commit/80036782f0c2e96d41652e97a066a295249aa4e5)) - -## [1.1.2](https://github.com/ScopeSV/kyseline/compare/v1.1.1...v1.1.2) (2023-10-26) - - -### Bug Fixes - -* more renaming ([f0cf64e](https://github.com/ScopeSV/kyseline/commit/f0cf64e5b71e3d86aab9788eb479e0865c4b4419)) -* remove dep ([1650a1c](https://github.com/ScopeSV/kyseline/commit/1650a1c307e22d0cda522032325b47e55b14339c)) -* rename package ([be30f34](https://github.com/ScopeSV/kyseline/commit/be30f34e19488697c93fdea2323790f226f6281b)) -* typo in package name ([8003678](https://github.com/ScopeSV/kyseline/commit/80036782f0c2e96d41652e97a066a295249aa4e5)) - -## [1.1.1](https://github.com/ScopeSV/kycli/compare/v1.1.0...v1.1.1) (2023-10-26) - - -### Bug Fixes - -* proper build run ([80ec25b](https://github.com/ScopeSV/kycli/commit/80ec25b6f0043c034efd817662c54f092c783506)) - -## [1.1.0](https://github.com/ScopeSV/kycli/compare/v1.0.0...v1.1.0) (2023-10-26) - - -### Features - -* proper depend ([37d581f](https://github.com/ScopeSV/kycli/commit/37d581fc7335ed547ec5f50c8c159b2b54bc1790)) -* test ([8f2dcc8](https://github.com/ScopeSV/kycli/commit/8f2dcc81168486acc8431b2fd937823267670300)) - -## 1.0.0 (2023-10-26) - - -### Features - -* add release please ([5370215](https://github.com/ScopeSV/kycli/commit/5370215f788bd494891ddfd62452356cc06d2865)) diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c081d9c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,7 @@ +Copyright (c) 2023 Stephan Valois + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..adb3cda --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# kyseline + +--- + +Cli tool for [Kysely](https://github.com/kysely-org/kysely) Query builder. +This tool can help you create + +## Quick start + +in the root of your project, add a config file `kyselinecfg.json` + +#### Config + +```json +{ + "migrationDir": path, // add path to your migrations directory + "useJsExtension": bool // optional +} +``` + +if `useJsExtension` is not provided, the tool will scan your project directory for a `tsconfig.json` file. If found, `.ts` will be used, else `.js` + +#### Commands + +To create a new table migration: + +```bash +$ npx kyseline migration:make create_foo_table foo:string bar:integer +``` + +To add fields to an existing table: + +```bash +$ npx kyseline migration:make add_foo_from_foo_table foo:string bar:integer +``` + +To remove fields from an existing table: + +```bash +$ npx kyseline migration:make remove_foo_from_footable foo +``` + + + + + + + +## Versioning + +The project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). + +## Authors + +- **Stephan Valois** - + + + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details