db-modeling-markdown 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -1,81 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [2.0.1] - 2022-12-08
-
-### Changes
-
-- [Feature]: [mariadb/mysql] provice method `fromDatabase`
-  Generate database model markdow files from a specific database.
-- [Feature]: [mariadb/mysql] provice method `toUpgradeSql`
-  Generate a SQL file with upgrade scripts.
-- [Feature]: provide more readable format for markdown files
-- [Feature]: [mariadb/mysql] provice method `genIndexFile`
-  Generate a `index.md` for all tables
-
-## [1.0.6] - 2021-11-19
-
-### Fix
-
-- [Defect]: error when there is an empty definition file
-
-## [1.0.5] - 2021-11-19
-
-### Fix
-
-- [Defect]: bad package
-
-## [1.0.4] - 2021-11-19
-
-### Fix
-
-- [Defect]: bad package
-
-## [1.0.3] - 2021-11-17
-
-### Fix
-
-- [Defect]: do not export file when file name is not provided.
-
-## [1.0.2] - 2020-02-23
-
-### Changes
-
-- [Feature]: provice method toMarkdown
-
-### Fixed
-
-- [Defect]: some document issues.
-
-## [1.0.1] - 2020-02-22
-
-### Fixed
-
-- No declaration files.
-
-## [1.0.0] - 2020-02-22
-
-### Added
-
-- Support Databases:
-
-  - DB2
-  - MariaDB
-  - MS SQL Server
-  - MySQL
-  - Oracle Database
-  - PostgreSQL
-  - SQLite
-
-- Support generate SQL scripts of create tables.
-- Support generate SQL scripts of create tables if not exists.
-- Support generate SQL scripts of drop then create tables.
-- Support generate SQL scripts of drop tables.
-- Support generate a json file of the database model.
-- Support generate an model object of the database model.

package/CONTRIBUTING.md

@@ -1,82 +0,0 @@
-# Contributing to db-modeling-markdown
-
-## Prepare Development Environment
-
-```sh
-npm add --global yarn
-npm add --global prettier typescript ts-node
-yarn
-yarn prepare
-```
-
-## Publish steps
-
-- change the package version `package.json`
-- change `CHANGELOG.md` for new features or fixes.
-- update sample scripts `examples\generator.ts`
-- update `README.md`
-  - version
-  - sample typescrit
-  - features and so on
-- build: run `yarn build`
-- check the package
-- edit `~/npmrc`, comment out the mirrow repositories
-- if need, `npm adduser` to add your npm user
-- publish: `npm publish --access public`
-- document: update gitee pages
-
-## Test
-
-- test all
-
-```sh
-yarn test
-```
-
-- test a specific test file
-
-```sh
-yarn test filename.test.ts
-```
-
-## Tips
-
-- we can use the variable `OverwriteExpected` to overwrite expected files
-
-[dbmService.test.ts](tests\services\dbmService.test.ts)
-
-```ts
-// used to overwrite expected data
-const OverwriteExpected = false
-```
-
-## Command
-
-- Generate table markdown files for all databases
-
-```typescript
-// run tests\data\generateMarkdown.ts
-```
-
-- husky: project initialization
-
-```sh
-# husky init (for project initialization)
-# npx husky-init
-```
-
-- husky: pre-commit command
-  [pre-commit.sh](.husky/pre-commit)
-
-## Guidelings
-
-### Coding Conventions
-
-- Use `tab` rather than `space`
-- using `.test.{ts, js}` extension for unit test files
-- folder and file name: `camel`
-- class name: `Pascal`
-- max line width: `120`
-- type scripts
-  - Semicolons: `true`
-  - Quotes: `single quoted`