typescript-schema-generator / typescript-schema-generator

An extendable generator for TypeScript schemas.

TypeScript Schema Generator

The core package of this mono repository is responsible for rendering TypeScript types and therefore entire schemas.

Development Prerequisites

• Make sure you have the Node.js runtime installed.
• Make sure you are using Node.js version 18. A simple way to switch versions is with the npm package n.

npm install --global n

sudo n 18

typescript-schema-generator's Issues

Setup EditorConfig

EditorConfig documentation
Add editorconfig.editorconfig to .vscode/extensions.json

Default

# Editor configuration, see http://editorconfig.org
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line_length = off
trim_trailing_whitespace = false

Setup GitHub action for automatic dates in project

Transition to ESM

Aside from the serve / watch command, Jest seems to be the thing making the biggest issues.

ts-jest-resolver ad a dev dependency helped, but the serve command made issues.

export default {
    displayName: 'core',
    preset: '../../jest.preset.js',
    resolver: 'ts-jest-resolver', // <--This helped
    testEnvironment: 'node',
    transform: {
        '^.+\\.[tj]s?$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
    },
    moduleFileExtensions: ['ts', 'js'],
    coverageDirectory: '../../coverage/packages/core',
};

Setup automatic package versioning

Conventional commits + Lerna

https://sonigaurav119.medium.com/how-i-use-lerna-with-nx-to-automate-the-versioning-1fada7f7f64f

Documentation for core package

Implement render reference type

Setup nx mono repository

Nx doucmentation
To scaffold a nx workspace of the latest version run npx create-nx-workspace@latest.
Implicitly this also defines the usage of npm instead of yarn.
Choose the option for an Integrated monorepo.
Add @nrwl/node dependecy to the repository.

To .vscode/extensions.json add

• davidanson.vscode-markdownlint for linting of markdown files

package.json

"name": "@typescript-schema-generator/typescript-schema-generator",
"repository": {
   "type": "git",
   "url": "https://github.com/typescript-schema-generator/typescript-schema-generator.git"
},
"bugs": {
   "url": "https://github.com/typescript-schema-generator/typescript-schema-generator/issues"
},

Setup nx open api v3 package

nx g @nrwl/node:lib open-api-v3 --buildable --publishable --importPath=@typescript-schema-generator/open-api-v3

Create Logo

Add prettier auto import organisation

Just install the development dependency prettier-plugin-organize-imports, prettier should pick it up automatically.

npm i -D prettier-plugin-organize-imports

Implement model for types

Discriminatable types for a union.

Setup nx open api v2 package

nx g @nrwl/node:lib open-api-v2 --buildable --publishable --importPath=@typescript-schema-generator/open-api-v2

Add CLI capabilities + export interfaces for adapters

Setup nx core package

nx g @nrwl/node:lib core --buildable --publishable --importPath=@typescript-schema-generator/core

Implement render intersection type

Setup Prettier

Prettier documentation
Add esbenp.prettier-vscode to .vscode/extensions.json

Also the following scripts, one for detecting violations and one for also tring to automatically fix them.

"format": "prettier --write .",
"format:check": "prettier --check .",

.prettierignore

# Add files here to ignore them from prettier formatting
/dist
/coverage

.prettierrc.json

Setup ESLint

ESLint documentation
Add dbaeumer.vscode-eslint to .vscode/extensions.json

Integrate with prettier by using eslint-config-prettier and eslint-plugin-prettier

npm i -D eslint eslint-config-prettier eslint-plugin-prettier @typescript-eslint/eslint-plugin @typescript-eslint/parser

package.json

   "lint": "eslint . --ext js,cjs,mjs,ts,cts,mts --fix",
   "lint:check": "eslint . --ext js,cjs,mjs,ts,cts,mts",

Documentation for open api v2 package

Implement render object type

Forbid yarn

Create .npmrc file with engine-strict = true.
In the package.json set

"engines": {
   "yarn": "please-use-npm",
}

Documentation for open api v3 package

Implement write schema file / files

Setup Nx remote caching

Run npx nx connect-to-nx-cloud to enable remote caching and make CI faster.

Also add to required checks to pass on the branch protection.

Implement render scalar type

Setup publish GitHub action

Maybe publish not only to npmjs but also consider GitHub packages

Implement comment renderer

Implement core renderers

Setup automatic dependency updates

Implement rendering options and context

Setup verify GitHub action

Think about using npm ci instead of npm i.
Setup caching for the install cammand as well.

build all, spell:check, format:check, lint:check

https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs

Setup Jest

Implement render literal type

Setup Codacy

Codacy is used to ensure a certain level of code quality.

Also add to required checks to pass on the branch protection.

How to integrate in required GitHub PR checks:
https://docs.codacy.com/v3.0/repositories-configure/integrations/github-integration
https://docs.codacy.com/getting-started/integrating-codacy-with-your-git-workflow

There also is a Codacy GitHub action template
https://github.com/typescript-schema-generator/typescript-schema-generator/new/main?filename=.github%2Fworkflows%2Fcodacy.yml&workflow_template=code-scanning%2Fcodacy

Add contributing guide

Implement transform name

Documentation for mono repository

Edit the readme file.

Implement render array type

Implement render enumeration type

Implement render union type

Setup cspell

CSpell documentation

npm i -D cspell

Create a .cspell.json.
Add streetsidesoftware.code-spell-checker to .vscode/extensions.json
Add a script "spell:check": "cspell ." to package.json