Skip to content

Commit

Permalink
Merge pull request #38 from Himenon/develop
Browse files Browse the repository at this point in the history
feat: Provide an API that makes it easy for users to extend the code generator.
  • Loading branch information
Himenon authored Apr 6, 2021
2 parents 5774177 + ad3ec06 commit 29cbc63
Show file tree
Hide file tree
Showing 153 changed files with 3,097 additions and 1,124 deletions.
110 changes: 19 additions & 91 deletions .dependency-cruiser.js
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
module.exports = {
extends: "dependency-cruiser/configs/recommended-strict",
/*
the 'dependency-cruiser/configs/recommended-strict' preset
contains these rules:
no-circular - flags all circular dependencies
no-orphans - flags orphan modules (except typescript .d.ts files)
no-deprecated-core - flags dependencies on deprecated node 'core' modules
no-deprecated-npm - flags dependencies on deprecated npm modules
no-non-package-json - flags (npm) dependencies that don't occur in package.json
not-to-unresolvable - flags dependencies that can't be resolved
no-duplicate-dep-types - flags dependencies that occur more than once in package.json
If you need to, you can override these rules. E.g. to ignore the
no-duplicate-dep-types rule, you can set its severity to "ignore" by
adding this to the 'forbidden' section:
{
name: 'no-duplicate-dep-types',
severity: 'ignore'
}
Also, by default, the preset does not follow any external modules (things in
node_modules or in yarn's plug'n'play magic). If you want to have that
differently, just override it the options.doNotFollow key.
*/
forbidden: [
{
name: "no-circular",
severity: "error",
comment: "Found a circular reference, please fix it.",
from: {},
to: {
circular: true,
},
},
{
name: "Invalid Code Template Dependency",
severity: "error",
from: {
path: "^src/code-templates",
},
to: {
path: "^src/internal",
},
},
{
name: "not-to-test",
comment:
Expand Down Expand Up @@ -101,80 +97,12 @@ module.exports = {
},
],
options: {
/* conditions specifying which files not to follow further when encountered:
- path: a regular expression to match
- dependencyTypes: see https://github.com/sverweij/dependency-cruiser/blob/develop/doc/rules-reference.md#dependencytypes
for a complete list
*/
doNotFollow: {
// path: 'node_modules',
dependencyTypes: ["npm", "npm-dev", "npm-optional", "npm-peer", "npm-bundled", "npm-no-pkg"],
},

/* conditions specifying which dependencies to exclude
- path: a regular expression to match
- dynamic: a boolean indicating whether to ignore dynamic (true) or static (false) dependencies.
leave out if you want to exclude neither (recommended!)
*/
// , exclude : {
// path: ''
// , dynamic: true
// }

/* pattern specifying which files to include (regular expression)
dependency-cruiser will skip everything not matching this pattern
*/
// , includeOnly : ''

/* list of module systems to cruise */
// , moduleSystems: ['amd', 'cjs', 'es6', 'tsd']

/* prefix for links in html and svg output (e.g. https://github.com/you/yourrepo/blob/develop/) */
// , prefix: ''

/* if true detect dependencies that only exist before typescript-to-javascript compilation */
tsPreCompilationDeps: true,

/* if true combines the package.jsons found from the module up to the base
folder the cruise is initiated from. Useful for how (some) mono-repos
manage dependencies & dependency definitions.
*/
// , combinedDependencies: false

/* if true leave symlinks untouched, otherwise use the realpath */
// , preserveSymlinks: false

/* Typescript project file ('tsconfig.json') to use for
(1) compilation and
(2) resolution (e.g. with the paths property)
The (optional) fileName attribute specifies which file to take (relative to
dependency-cruiser's current working directory). When not provided
defaults to './tsconfig.json'.
*/
tsConfig: {
fileName: "./tsconfig.json",
},

/* Webpack configuration to use to get resolve options from.
The (optional) fileName attribute specifies which file to take (relative to dependency-cruiser's
current working directory. When not provided defaults to './webpack.conf.js'.
The (optional) `env` and `args` attributes contain the parameters to be passed if
your webpack config is a function and takes them (see webpack documentation
for details)
*/
// , webpackConfig: {
// fileName: './webpack.conf.js'
// , env: {}
// , args: {}
// }

/* How to resolve external modules - use "yarn-pnp" if you're using yarn's Plug'n'Play.
otherwise leave it out (or set to the default, which is 'node_modules')
*/
// , externalModuleResolutionStrategy: 'node_modules'
},
};
// generated: [email protected] on 2019-11-21T01:41:12.817Z
134 changes: 34 additions & 100 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,207 +4,141 @@ All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

<a name="0.7.2"></a>
## 0.7.2 (2021-04-04)

## 0.7.2 (2021-04-04)

### Code Refactoring

* remove v3 directory ([#29](https://github.com/Himenon/openapi-typescript-code-generator/issues/29)) ([4d1eee4](https://github.com/Himenon/openapi-typescript-code-generator/commit/4d1eee4))




- remove v3 directory ([#29](https://github.com/Himenon/openapi-typescript-code-generator/issues/29)) ([4d1eee4](https://github.com/Himenon/openapi-typescript-code-generator/commit/4d1eee4))

<a name="0.7.1"></a>
## 0.7.1 (2021-04-04)

## 0.7.1 (2021-04-04)

### Chores

* **deps:** update library version ([#28](https://github.com/Himenon/openapi-typescript-code-generator/issues/28)) ([f19603b](https://github.com/Himenon/openapi-typescript-code-generator/commit/f19603b))




- **deps:** update library version ([#28](https://github.com/Himenon/openapi-typescript-code-generator/issues/28)) ([f19603b](https://github.com/Himenon/openapi-typescript-code-generator/commit/f19603b))

<a name="0.7.0"></a>
# 0.7.0 (2021-04-04)

# 0.7.0 (2021-04-04)

### Features

* support dual package ([#27](https://github.com/Himenon/openapi-typescript-code-generator/issues/27)) ([1cb8507](https://github.com/Himenon/openapi-typescript-code-generator/commit/1cb8507))




- support dual package ([#27](https://github.com/Himenon/openapi-typescript-code-generator/issues/27)) ([1cb8507](https://github.com/Himenon/openapi-typescript-code-generator/commit/1cb8507))

<a name="0.6.2"></a>

## 0.6.2 (2021-04-01)

**Note:** Version bump only for package @himenon/openapi-typescript-code-generator





<a name="0.6.1"></a>

## 0.6.1 (2021-04-01)

**Note:** Version bump only for package @himenon/openapi-typescript-code-generator





<a name="0.6.0"></a>
# 0.6.0 (2021-03-23)

# 0.6.0 (2021-03-23)

### Features

* Support sync API Client generation ([#22](https://github.com/Himenon/openapi-typescript-code-generator/issues/22)) ([4bbde34](https://github.com/Himenon/openapi-typescript-code-generator/commit/4bbde34))




- Support sync API Client generation ([#22](https://github.com/Himenon/openapi-typescript-code-generator/issues/22)) ([4bbde34](https://github.com/Himenon/openapi-typescript-code-generator/commit/4bbde34))

<a name="0.5.0"></a>
# 0.5.0 (2021-03-22)

# 0.5.0 (2021-03-22)

### Features

* **codegen:** add error response type name list and add allowOperationIds ([#20](https://github.com/Himenon/openapi-typescript-code-generator/issues/20)) ([924c4a1](https://github.com/Himenon/openapi-typescript-code-generator/commit/924c4a1))




- **codegen:** add error response type name list and add allowOperationIds ([#20](https://github.com/Himenon/openapi-typescript-code-generator/issues/20)) ([924c4a1](https://github.com/Himenon/openapi-typescript-code-generator/commit/924c4a1))

<a name="0.4.0"></a>
# 0.4.0 (2021-02-18)

# 0.4.0 (2021-02-18)

### Features

* **comment:** Use the defined comment ([#19](https://github.com/Himenon/openapi-typescript-code-generator/issues/19)) ([9e90e7b](https://github.com/Himenon/openapi-typescript-code-generator/commit/9e90e7b))




- **comment:** Use the defined comment ([#19](https://github.com/Himenon/openapi-typescript-code-generator/issues/19)) ([9e90e7b](https://github.com/Himenon/openapi-typescript-code-generator/commit/9e90e7b))

<a name="0.3.0"></a>
# 0.3.0 (2021-02-01)

# 0.3.0 (2021-02-01)

### Features

* update codegen api and types ([#17](https://github.com/Himenon/openapi-typescript-code-generator/issues/17)) ([1c6e748](https://github.com/Himenon/openapi-typescript-code-generator/commit/1c6e748))




- update codegen api and types ([#17](https://github.com/Himenon/openapi-typescript-code-generator/issues/17)) ([1c6e748](https://github.com/Himenon/openapi-typescript-code-generator/commit/1c6e748))

<a name="0.2.0"></a>
# 0.2.0 (2021-02-01)

# 0.2.0 (2021-02-01)

### Features

* Support build github-rest-api-description ([#16](https://github.com/Himenon/openapi-typescript-code-generator/issues/16)) ([0323f9f](https://github.com/Himenon/openapi-typescript-code-generator/commit/0323f9f)), closes [#12](https://github.com/Himenon/openapi-typescript-code-generator/issues/12) [#13](https://github.com/Himenon/openapi-typescript-code-generator/issues/13) [#14](https://github.com/Himenon/openapi-typescript-code-generator/issues/14) [#15](https://github.com/Himenon/openapi-typescript-code-generator/issues/15)




- Support build github-rest-api-description ([#16](https://github.com/Himenon/openapi-typescript-code-generator/issues/16)) ([0323f9f](https://github.com/Himenon/openapi-typescript-code-generator/commit/0323f9f)), closes [#12](https://github.com/Himenon/openapi-typescript-code-generator/issues/12) [#13](https://github.com/Himenon/openapi-typescript-code-generator/issues/13) [#14](https://github.com/Himenon/openapi-typescript-code-generator/issues/14) [#15](https://github.com/Himenon/openapi-typescript-code-generator/issues/15)

<a name="0.1.7"></a>
## 0.1.7 (2021-01-17)

## 0.1.7 (2021-01-17)

### Code Refactoring

* **data-structure:** use [@himenon](https://github.com/himenon)/path-oriented-data-structure ([#11](https://github.com/Himenon/openapi-typescript-code-generator/issues/11)) ([bfe7a4d](https://github.com/Himenon/openapi-typescript-code-generator/commit/bfe7a4d))




- **data-structure:** use [@himenon](https://github.com/himenon)/path-oriented-data-structure ([#11](https://github.com/Himenon/openapi-typescript-code-generator/issues/11)) ([bfe7a4d](https://github.com/Himenon/openapi-typescript-code-generator/commit/bfe7a4d))

<a name="0.1.6"></a>
## 0.1.6 (2021-01-16)

## 0.1.6 (2021-01-16)

### Bug Fixes

* **vadliation:** example property ([#10](https://github.com/Himenon/openapi-typescript-code-generator/issues/10)) ([c25ddac](https://github.com/Himenon/openapi-typescript-code-generator/commit/c25ddac)), closes [#9](https://github.com/Himenon/openapi-typescript-code-generator/issues/9)




- **vadliation:** example property ([#10](https://github.com/Himenon/openapi-typescript-code-generator/issues/10)) ([c25ddac](https://github.com/Himenon/openapi-typescript-code-generator/commit/c25ddac)), closes [#9](https://github.com/Himenon/openapi-typescript-code-generator/issues/9)

<a name="0.1.5"></a>
## 0.1.5 (2021-01-15)

## 0.1.5 (2021-01-15)

### Bug Fixes

* unresolved reference ([#8](https://github.com/Himenon/openapi-typescript-code-generator/issues/8)) ([07e0e6d](https://github.com/Himenon/openapi-typescript-code-generator/commit/07e0e6d)), closes [#7](https://github.com/Himenon/openapi-typescript-code-generator/issues/7)




- unresolved reference ([#8](https://github.com/Himenon/openapi-typescript-code-generator/issues/8)) ([07e0e6d](https://github.com/Himenon/openapi-typescript-code-generator/commit/07e0e6d)), closes [#7](https://github.com/Himenon/openapi-typescript-code-generator/issues/7)

<a name="0.1.4"></a>
## 0.1.4 (2021-01-14)

## 0.1.4 (2021-01-14)

### Chores

* fix bugs and update docs ([#6](https://github.com/Himenon/openapi-typescript-code-generator/issues/6)) ([13c233f](https://github.com/Himenon/openapi-typescript-code-generator/commit/13c233f))




- fix bugs and update docs ([#6](https://github.com/Himenon/openapi-typescript-code-generator/issues/6)) ([13c233f](https://github.com/Himenon/openapi-typescript-code-generator/commit/13c233f))

<a name="0.1.3"></a>
## 0.1.3 (2021-01-12)

## 0.1.3 (2021-01-12)

### Documentation

* remove v3 ([#5](https://github.com/Himenon/openapi-typescript-code-generator/issues/5)) ([8082df4](https://github.com/Himenon/openapi-typescript-code-generator/commit/8082df4))




- remove v3 ([#5](https://github.com/Himenon/openapi-typescript-code-generator/issues/5)) ([8082df4](https://github.com/Himenon/openapi-typescript-code-generator/commit/8082df4))

<a name="0.1.2"></a>
## 0.1.2 (2021-01-12)

## 0.1.2 (2021-01-12)

### Bug Fixes

* after release some bugs ([#4](https://github.com/Himenon/openapi-typescript-code-generator/issues/4)) ([1a756bd](https://github.com/Himenon/openapi-typescript-code-generator/commit/1a756bd))




- after release some bugs ([#4](https://github.com/Himenon/openapi-typescript-code-generator/issues/4)) ([1a756bd](https://github.com/Himenon/openapi-typescript-code-generator/commit/1a756bd))

<a name="0.1.1"></a>
## 0.1.1 (2021-01-12)

## 0.1.1 (2021-01-12)

### Builds

* **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([#3](https://github.com/Himenon/openapi-typescript-code-generator/issues/3)) ([0eedc0e](https://github.com/Himenon/openapi-typescript-code-generator/commit/0eedc0e))




- **deps:** bump node-notifier from 8.0.0 to 8.0.1 ([#3](https://github.com/Himenon/openapi-typescript-code-generator/issues/3)) ([0eedc0e](https://github.com/Himenon/openapi-typescript-code-generator/commit/0eedc0e))

<a name="0.1.0"></a>
# 0.1.0 (2021-01-12)

# 0.1.0 (2021-01-12)

### Features

* Initial commit of OpenAPI TypeScript Generator ([#2](https://github.com/Himenon/openapi-typescript-code-generator/issues/2)) ([df022c2](https://github.com/Himenon/openapi-typescript-code-generator/commit/df022c2))
- Initial commit of OpenAPI TypeScript Generator ([#2](https://github.com/Himenon/openapi-typescript-code-generator/issues/2)) ([df022c2](https://github.com/Himenon/openapi-typescript-code-generator/commit/df022c2))
Loading

0 comments on commit 29cbc63

Please sign in to comment.