├── .editorconfig ├── .eslintignore ├── .eslintrc.json ├── .gitattributes ├── .github ├── header.svg ├── husky │ ├── .gitignore │ └── pre-commit ├── renovate.json └── workflows │ ├── codeql-analysis.yml │ ├── pull-request.yml │ └── workflow.yml ├── .gitignore ├── .npmignore ├── .prettierrc ├── CHANGELOG.md ├── LICENSE ├── README.md ├── docs ├── README.md ├── interfaces │ ├── main.generateoptions.md │ └── main.prettieroptions.md └── modules │ ├── main.md │ ├── types.md │ └── util.md ├── jest.config.js ├── package.json ├── src ├── __tests__ │ ├── main.test.ts │ └── util.test.ts ├── main.ts ├── types.ts └── util.ts ├── tsconfig.jest.json ├── tsconfig.json └── yarn.lock /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | end_of_line = lf 6 | trim_trailing_whitespace = true 7 | insert_final_newline = true 8 | 9 | [*.md] 10 | insert_final_newline = false 11 | trim_trailing_whitespace = false 12 | 13 | [*.{js,jsx,json,ts,tsx,yml}] 14 | indent_size = 2 15 | indent_style = space 16 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | dist/ 2 | lib/ 3 | node_modules/ 4 | jest.config.js 5 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "eslint:recommended", 4 | "plugin:@typescript-eslint/eslint-recommended", 5 | "plugin:@typescript-eslint/recommended", 6 | "plugin:jest/recommended", 7 | "prettier" 8 | ], 9 | "env": { 10 | "browser": false, 11 | "es6": true, 12 | "node": true 13 | }, 14 | "parser": "@typescript-eslint/parser", 15 | "parserOptions": { 16 | "project": "tsconfig.json", 17 | "sourceType": "module" 18 | }, 19 | "plugins": ["@typescript-eslint", "jest", "import"], 20 | "rules": { 21 | "sort-imports": ["error", { "ignoreDeclarationSort": true }], 22 | "import/order": [ 23 | "error", 24 | { "alphabetize": { "order": "asc" }, "newlines-between": "never" } 25 | ], 26 | "no-return-await": "error", 27 | "no-console": "error", 28 | "import/no-default-export": "error", 29 | "import/no-extraneous-dependencies": "error", 30 | "import/no-unassigned-import": "error", 31 | "@typescript-eslint/no-unused-vars": [ 32 | "error", 33 | { "argsIgnorePattern": "^_", "caughtErrors": "all" } 34 | ], 35 | "@typescript-eslint/no-unused-expressions": "error" 36 | }, 37 | "overrides": [ 38 | { 39 | "files": ["**/*.test.ts"], 40 | "rules": { 41 | "@typescript-eslint/ban-ts-comment": "off", 42 | "@typescript-eslint/no-explicit-any": "off", 43 | "@typescript-eslint/no-unused-vars": "off", 44 | "@typescript-eslint/no-var-requires": "off" 45 | } 46 | } 47 | ] 48 | } 49 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | docs/**/*.md linguist-generated 2 | -------------------------------------------------------------------------------- /.github/header.svg: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /.github/husky/.gitignore: -------------------------------------------------------------------------------- 1 | _ 2 | -------------------------------------------------------------------------------- /.github/husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | yarn lint-staged 5 | -------------------------------------------------------------------------------- /.github/renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": ["config:base"], 4 | "lockFileMaintenance": { "enabled": true, "automerge": true }, 5 | "rangeStrategy": "replace", 6 | "postUpdateOptions": ["yarnDedupeHighest"] 7 | } 8 | -------------------------------------------------------------------------------- /.github/workflows/codeql-analysis.yml: -------------------------------------------------------------------------------- 1 | # For most projects, this workflow file will not need changing; you simply need 2 | # to commit it to your repository. 3 | # 4 | # You may wish to alter this file to override the set of languages analyzed, 5 | # or to provide custom queries or build logic. 6 | name: "CodeQL" 7 | 8 | on: 9 | push: 10 | branches: [main] 11 | pull_request: 12 | # The branches below must be a subset of the branches above 13 | branches: [main] 14 | schedule: 15 | - cron: '0 12 * * 0' 16 | 17 | jobs: 18 | analyze: 19 | name: Analyze 20 | runs-on: ubuntu-latest 21 | 22 | strategy: 23 | fail-fast: false 24 | matrix: 25 | # Override automatic language detection by changing the below list 26 | # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python'] 27 | language: ['javascript'] 28 | # Learn more... 29 | # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection 30 | 31 | steps: 32 | - name: Checkout repository 33 | uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 34 | with: 35 | # We must fetch at least the immediate parents so that if this is 36 | # a pull request then we can checkout the head. 37 | fetch-depth: 2 38 | 39 | # If this run was triggered by a pull request event, then checkout 40 | # the head of the pull request instead of the merge commit. 41 | - run: git checkout HEAD^2 42 | if: ${{ github.event_name == 'pull_request' }} 43 | 44 | # Initializes the CodeQL tools for scanning. 45 | - name: Initialize CodeQL 46 | uses: github/codeql-action/init@v1 47 | with: 48 | languages: ${{ matrix.language }} 49 | # If you wish to specify custom queries, you can do so here or in a config file. 50 | # By default, queries listed here will override any specified in a config file. 51 | # Prefix the list here with "+" to use these queries and those in the config file. 52 | # queries: ./path/to/local/query, your-org/your-repo/queries@main 53 | 54 | # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). 55 | # If this step fails, then you should remove it and run the build manually (see below) 56 | - name: Autobuild 57 | uses: github/codeql-action/autobuild@v1 58 | 59 | # ℹ️ Command-line programs to run using the OS shell. 60 | # 📚 https://git.io/JvXDl 61 | 62 | # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines 63 | # and modify them (or add more) to build your code if your project 64 | # uses a compiled language 65 | 66 | #- run: | 67 | # make bootstrap 68 | # make release 69 | 70 | - name: Perform CodeQL Analysis 71 | uses: github/codeql-action/analyze@v1 -------------------------------------------------------------------------------- /.github/workflows/pull-request.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | on: [pull_request] 3 | 4 | jobs: 5 | build: 6 | 7 | runs-on: ubuntu-latest 8 | 9 | strategy: 10 | matrix: 11 | node-version: [14.x] 12 | 13 | steps: 14 | - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 15 | - name: Use Node.js ${{ matrix.node-version }} 16 | uses: actions/setup-node@v1 17 | with: 18 | node-version: ${{ matrix.node-version }} 19 | - name: Get yarn cache directory path 20 | id: yarn-cache-dir-path 21 | run: echo "::set-output name=dir::$(yarn cache dir)" 22 | 23 | - uses: actions/cache@v1 24 | id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) 25 | with: 26 | path: ${{ steps.yarn-cache-dir-path.outputs.dir }} 27 | key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} 28 | restore-keys: | 29 | ${{ runner.os }}-yarn- 30 | - run: yarn install 31 | - run: yarn build 32 | - run: yarn lint 33 | - run: yarn test --passWithNoTests 34 | env: 35 | CI: true 36 | - run: npx codecov 37 | -------------------------------------------------------------------------------- /.github/workflows/workflow.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | on: 3 | push: 4 | branches: 5 | - main 6 | 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | 11 | strategy: 12 | matrix: 13 | node-version: [14.x] 14 | 15 | steps: 16 | - uses: GoogleCloudPlatform/release-please-action@v2 17 | id: release 18 | with: 19 | token: ${{ secrets.GITHUB_TOKEN }} 20 | release-type: node 21 | 22 | - if: ${{ steps.release.outputs.release_created }} 23 | uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 24 | 25 | - if: ${{ steps.release.outputs.release_created }} 26 | name: Use Node.js ${{ matrix.node-version }} 27 | uses: actions/setup-node@v1 28 | with: 29 | node-version: ${{ matrix.node-version }} 30 | registry-url: 'https://registry.npmjs.org' 31 | 32 | - if: ${{ steps.release.outputs.release_created }} 33 | name: Get yarn cache directory path 34 | id: yarn-cache-dir-path 35 | run: echo "::set-output name=dir::$(yarn cache dir)" 36 | 37 | - if: ${{ steps.release.outputs.release_created }} 38 | uses: actions/cache@v1 39 | id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`) 40 | with: 41 | path: ${{ steps.yarn-cache-dir-path.outputs.dir }} 42 | key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} 43 | restore-keys: | 44 | ${{ runner.os }}-yarn- 45 | 46 | - if: ${{ steps.release.outputs.release_created }} 47 | run: yarn install 48 | 49 | - if: ${{ steps.release.outputs.release_created }} 50 | run: yarn run build 51 | 52 | - if: ${{ steps.release.outputs.release_created }} 53 | run: yarn publish 54 | env: 55 | NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} 56 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | # Compiled test files 2 | lib/**/*.spec.* 3 | 4 | # Source files 5 | src/ 6 | 7 | # Examples 8 | examples/ 9 | 10 | # Code coverage output 11 | coverage/ 12 | 13 | # NPM stuff 14 | node_modules/ 15 | npm-debug.log* 16 | 17 | # Mac stuff 18 | .DS_Store 19 | 20 | # Tools 21 | .editorconfig 22 | .eslintignore 23 | jest.config.js 24 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "singleQuote": true, 3 | "trailingComma": "all", 4 | "proseWrap": "always", 5 | "overrides": [ 6 | { 7 | "files": "*.ts", 8 | "options": { 9 | "parser": "typescript" 10 | } 11 | } 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to this project will be documented in this file. See 4 | [Conventional Commits](https://conventionalcommits.org) for commit guidelines. 5 | 6 | # [2.0.0-alpha.3](https://github.com/cobraz/generate-runtypes/compare/v2.0.0-alpha.2...v2.0.0-alpha.3) (2021-03-28) 7 | 8 | 9 | ### Bug Fixes 10 | 11 | * intersection was generated with wrong name ([f94d755](https://github.com/cobraz/generate-runtypes/commit/f94d7556912d3a855bd3fb200808077bfd8142ac)) 12 | 13 | # [2.0.0-alpha.2](https://github.com/cobraz/generate-runtypes/compare/v2.0.0-alpha.1...v2.0.0-alpha.2) (2021-03-27) 14 | 15 | 16 | ### Bug Fixes 17 | 18 | * release please ([f09823b](https://github.com/cobraz/generate-runtypes/commit/f09823bea1ab5d3496ea5e9d62843e438531b58c)) 19 | 20 | # [2.0.0-alpha.1](https://github.com/cobraz/generate-runtypes/compare/v1.1.1...v2.0.0-alpha.1) (2021-03-25) 21 | 22 | 23 | ### Code Refactoring 24 | 25 | * Remove non-alt version ([1625b96](https://github.com/cobraz/generate-runtypes/commit/1625b96c6cc31aea2f972cbe641b1a051183e1b8)) 26 | 27 | 28 | ### Features 29 | 30 | * Add groupFieldKinds, symbol type, remove void and partial/readonly ([742ce62](https://github.com/cobraz/generate-runtypes/commit/742ce62301a19e77e776606b35611a96b30b51f6)) 31 | * Alternative object format for runtypes ([#9](https://github.com/cobraz/generate-runtypes/issues/9)) ([baaaa02](https://github.com/cobraz/generate-runtypes/commit/baaaa02973dd7a5a909400ed8c1ca20dc860efed)) 32 | * More compact raw source output ([c76338d](https://github.com/cobraz/generate-runtypes/commit/c76338dabfb44eba7fe1f1c7166153e6c99f7662)) 33 | * Try alternate writer for for alt_serializer ([6543c99](https://github.com/cobraz/generate-runtypes/commit/6543c9981298dd82dd1026dac513928207b1519e)) 34 | 35 | 36 | ### BREAKING CHANGES 37 | 38 | * This package no longer require `ts-morph` and does not take inn file argument. Please consult our README.md for more information 39 | 40 | ### [3.1.1](https://www.github.com/cobraz/generate-runtypes/compare/v3.1.0...v3.1.1) (2022-11-27) 41 | 42 | 43 | ### Bug Fixes 44 | 45 | * Don't throw on names with leading number ([#181](https://www.github.com/cobraz/generate-runtypes/issues/181)) ([7bcd1fb](https://www.github.com/cobraz/generate-runtypes/commit/7bcd1fbc2826e5f2991f1c244d964a219ab741c0)) 46 | 47 | ## [3.1.0](https://www.github.com/cobraz/generate-runtypes/compare/v3.0.0...v3.1.0) (2021-07-04) 48 | 49 | 50 | ### Features 51 | 52 | * Export NameFunction type ([#123](https://www.github.com/cobraz/generate-runtypes/issues/123)) ([1f1d314](https://www.github.com/cobraz/generate-runtypes/commit/1f1d31451a1ab50f2f702be283559f16f17c9e8c)) 53 | 54 | 55 | ### Bug Fixes 56 | 57 | * escape characters in field names ([#124](https://www.github.com/cobraz/generate-runtypes/issues/124)) ([3d9cf65](https://www.github.com/cobraz/generate-runtypes/commit/3d9cf651f284a287a6d89b336bd20fbacf7730d2)) 58 | 59 | ## [3.0.0](https://www.github.com/cobraz/generate-runtypes/compare/v2.1.0...v3.0.0) (2021-06-09) 60 | 61 | 62 | ### ⚠ BREAKING CHANGES 63 | 64 | * Previous versions vould emit code that doesn't deal with cycles, this version does. The previous versions would likely emit illegal code, nevertheless, this is breaking change. 65 | * Anyone relying on ES6 being the target when transpiling, will need to adjust their settings when consuming this package. 66 | 67 | ### Features 68 | 69 | * Add flag to detect unknown named types ([#106](https://www.github.com/cobraz/generate-runtypes/issues/106)) ([85267f0](https://www.github.com/cobraz/generate-runtypes/commit/85267f08eaeba568a8f88fe3c9d525a91f4091bc)) 70 | * Add flag to throw on cyclic dependencies between named types ([#101](https://www.github.com/cobraz/generate-runtypes/issues/101)) ([2e33303](https://www.github.com/cobraz/generate-runtypes/commit/2e333030746494332efb373ce82835e054858f7a)) 71 | * Add support for comments in output ([#80](https://www.github.com/cobraz/generate-runtypes/issues/80)) ([b1da522](https://www.github.com/cobraz/generate-runtypes/commit/b1da522adbb07da3f04cb1f5296858c36c463482)) 72 | * Support generating lazy runtypes ([#107](https://www.github.com/cobraz/generate-runtypes/issues/107)) ([a63d32c](https://www.github.com/cobraz/generate-runtypes/commit/a63d32c6035c1592e72be65c5aabda672a4eaec4)) 73 | * Topological sort of dependencies ([#114](https://www.github.com/cobraz/generate-runtypes/issues/114)) ([f0a80b5](https://www.github.com/cobraz/generate-runtypes/commit/f0a80b5dfbe7d2fbbc52556ead2f679af84ddb12)) 74 | 75 | 76 | ### Bug Fixes 77 | 78 | * generate correct type for dict/record ([8037530](https://www.github.com/cobraz/generate-runtypes/commit/8037530b3543b95af44f0e901309dfbb1b95a450)) 79 | 80 | 81 | ### Miscellaneous Chores 82 | 83 | * Update target to ES2019 ([#95](https://www.github.com/cobraz/generate-runtypes/issues/95)) ([a647c07](https://www.github.com/cobraz/generate-runtypes/commit/a647c073e81d75bfb5fa465c31805e9b5c06ec46)) 84 | 85 | ## [2.1.0](https://www.github.com/cobraz/generate-runtypes/compare/v2.0.1...v2.1.0) (2021-04-27) 86 | 87 | 88 | ### Features 89 | 90 | * Add null and undefined types [#64](https://www.github.com/cobraz/generate-runtypes/issues/64) ([ac8be76](https://www.github.com/cobraz/generate-runtypes/commit/ac8be76df519e9c968eb09592827ba66195ecf77)) 91 | 92 | ### [2.0.1](https://www.github.com/cobraz/generate-runtypes/compare/v2.0.0...v2.0.1) (2021-04-23) 93 | 94 | 95 | ### Bug Fixes 96 | 97 | * use formatter function for all named types ([#52](https://www.github.com/cobraz/generate-runtypes/issues/52)) ([335fc0e](https://www.github.com/cobraz/generate-runtypes/commit/335fc0eca6daaaa84d8ad670321c546c4ac8c894)) 98 | 99 | ## [2.0.0](https://www.github.com/cobraz/generate-runtypes/compare/v1.1.1...v2.0.0) (2021-04-16) 100 | 101 | 102 | ### ⚠ BREAKING CHANGES 103 | 104 | * This package no longer require `ts-morph` and does not take inn file argument. Please consult our README.md for more information 105 | 106 | ### Features 107 | 108 | * Add groupFieldKinds, symbol type, remove void and partial/readonly ([742ce62](https://www.github.com/cobraz/generate-runtypes/commit/742ce62301a19e77e776606b35611a96b30b51f6)) 109 | * Alternative object format for runtypes ([#9](https://www.github.com/cobraz/generate-runtypes/issues/9)) ([baaaa02](https://www.github.com/cobraz/generate-runtypes/commit/baaaa02973dd7a5a909400ed8c1ca20dc860efed)) 110 | * More compact raw source output ([c76338d](https://www.github.com/cobraz/generate-runtypes/commit/c76338dabfb44eba7fe1f1c7166153e6c99f7662)) 111 | * output type definitions and allow custom names ([#30](https://www.github.com/cobraz/generate-runtypes/issues/30)) ([bbad2d3](https://www.github.com/cobraz/generate-runtypes/commit/bbad2d3c8a0dad408bd9d950964d6cc08c25b059)), closes [#28](https://www.github.com/cobraz/generate-runtypes/issues/28) 112 | * Try alternate writer for for alt_serializer ([6543c99](https://www.github.com/cobraz/generate-runtypes/commit/6543c9981298dd82dd1026dac513928207b1519e)) 113 | 114 | 115 | ### Bug Fixes 116 | 117 | * Getting ready to release v2 ([8080edc](https://www.github.com/cobraz/generate-runtypes/commit/8080edcfb26e25ade27d7b5f3cc4b037b6aa0c29)) 118 | * infinite loop on empty record ([#34](https://www.github.com/cobraz/generate-runtypes/issues/34)) ([5596de4](https://www.github.com/cobraz/generate-runtypes/commit/5596de4633b65c151a9024f3130ea941c653453e)) 119 | * intersection was generated with wrong name ([f94d755](https://www.github.com/cobraz/generate-runtypes/commit/f94d7556912d3a855bd3fb200808077bfd8142ac)) 120 | * release please ([f09823b](https://www.github.com/cobraz/generate-runtypes/commit/f09823bea1ab5d3496ea5e9d62843e438531b58c)) 121 | 122 | 123 | ### Code Refactoring 124 | 125 | * Remove non-alt version ([1625b96](https://www.github.com/cobraz/generate-runtypes/commit/1625b96c6cc31aea2f972cbe641b1a051183e1b8)) 126 | 127 | ## [1.1.1](https://github.com/cobraz/generate-runtypes/compare/v1.1.0...v1.1.1) (2021-03-21) 128 | 129 | 130 | ### Bug Fixes 131 | 132 | * Reference correct `main` file ([0a9da84](https://github.com/cobraz/generate-runtypes/commit/0a9da84008fea6c66d71212460f4f12cd2ae49a6)) 133 | 134 | # [1.1.0](https://github.com/cobraz/generate-runtypes/compare/v1.0.0...v1.1.0) (2021-03-21) 135 | 136 | 137 | ### Features 138 | 139 | * initial commit ([e1e7d90](https://github.com/cobraz/generate-runtypes/commit/e1e7d90a015b9ebd2bb35becca5a144b8d1b2fe2)) 140 | 141 | # 1.0.0 (2021-03-21) 142 | 143 | 144 | ### Features 145 | 146 | * initial commit ([048073d](https://github.com/cobraz/generate-runtypes/commit/048073dc45dab424e280a976ec6586aa500224d9)) 147 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | Generate Runtypes types 3 | 4 | A code generator for Runtypes types 5 | 6 | [![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental) 7 | [![NPM version](https://img.shields.io/npm/v/generate-runtypes.svg)](https://www.npmjs.com/package/generate-runtypes) 8 | [![codecov](https://codecov.io/gh/cobraz/generate-runtypes/branch/main/graph/badge.svg)](https://codecov.io/gh/cobraz/generate-runtypes) 9 | 10 |
11 | 12 | This library aims to provide an intuitive and easy way to generate 13 | [Runtypes][runtypes] types. This package aims to be a great utility for a 14 | conversion package (e.g. JSON Schema to Runtypes). 15 | 16 | We are thankful for all help with adding new functionality, fixing issues, or 17 | improve the package. Feel free to open issues and pull requests ❤️ 18 | 19 | ## Documentation 20 | 21 | Apart from this README, you can find details and examples of using the SDK in 22 | the following places: 23 | 24 | - [API Documentation][docs] 25 | 26 | ## Example 27 | 28 | ```typescript 29 | import { generateRuntypes } from 'generate-runtypes'; 30 | 31 | const sourceCode = generateRuntypes([ 32 | { 33 | name: 'Comment', 34 | type: { 35 | kind: 'record', 36 | fields: [ 37 | { name: 'author', type: { kind: 'string' } }, 38 | { name: 'body', type: { kind: 'string' } }, 39 | { name: 'timestamp', type: { kind: 'number' } }, 40 | ], 41 | }, 42 | }, 43 | { 44 | name: 'Post', 45 | export: true, 46 | type: { 47 | kind: 'record', 48 | fields: [ 49 | { name: 'title', type: { kind: 'string' } }, 50 | { name: 'body', type: { kind: 'string' } }, 51 | { name: 'author', type: { kind: 'string' } }, 52 | { 53 | name: 'comments', 54 | type: { kind: 'array', type: { kind: 'named', name: 'Comment' } }, 55 | }, 56 | ], 57 | }, 58 | }, 59 | ]); 60 | ``` 61 | 62 | The generated code looks like this after formatting: 63 | 64 | ```typescript 65 | import * as rt from 'runtypes'; 66 | 67 | const Comment = rt.Record({ 68 | author: rt.String, 69 | body: rt.String, 70 | timestamp: rt.Number, 71 | }); 72 | 73 | export const Post = rt.Record({ 74 | title: rt.String, 75 | body: rt.String, 76 | author: rt.String, 77 | comments: rt.Array(Comment), 78 | }); 79 | ``` 80 | 81 | [runtypes]: https://github.com/pelotom/runtypes 82 | [docs]: ./docs 83 | -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | generate-runtypes 2 | 3 | # generate-runtypes 4 | 5 | ## Table of contents 6 | 7 | ### Modules 8 | 9 | - [main](modules/main.md) 10 | - [types](modules/types.md) 11 | - [util](modules/util.md) 12 | -------------------------------------------------------------------------------- /docs/interfaces/main.generateoptions.md: -------------------------------------------------------------------------------- 1 | [generate-runtypes](../README.md) / [main](../modules/main.md) / GenerateOptions 2 | 3 | # Interface: GenerateOptions 4 | 5 | [main](../modules/main.md).GenerateOptions 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [format](main.generateoptions.md#format) 12 | - [formatOptions](main.generateoptions.md#formatoptions) 13 | - [formatRuntypeName](main.generateoptions.md#formatruntypename) 14 | - [formatTypeName](main.generateoptions.md#formattypename) 15 | - [includeImport](main.generateoptions.md#includeimport) 16 | - [includeTypes](main.generateoptions.md#includetypes) 17 | - [rejectCyclicDependencies](main.generateoptions.md#rejectcyclicdependencies) 18 | - [rejectUnknownNamedTypes](main.generateoptions.md#rejectunknownnamedtypes) 19 | 20 | ## Properties 21 | 22 | ### format 23 | 24 | • `Optional` **format**: *boolean* 25 | 26 | Apply formatting to the output using prettier. Default: true 27 | 28 | Defined in: [src/main.ts:58](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L58) 29 | 30 | ___ 31 | 32 | ### formatOptions 33 | 34 | • `Optional` **formatOptions**: [*PrettierOptions*](main.prettieroptions.md) 35 | 36 | Options to use for prettier formatting. Default: undefined 37 | 38 | Defined in: [src/main.ts:61](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L61) 39 | 40 | ___ 41 | 42 | ### formatRuntypeName 43 | 44 | • `Optional` **formatRuntypeName**: NameFunction 45 | 46 | Function used to format the names of generated runtypes. 47 | The function is passed in a name and must return a string that will be 48 | used in place of that name. 49 | 50 | Defined in: [src/main.ts:95](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L95) 51 | 52 | ___ 53 | 54 | ### formatTypeName 55 | 56 | • `Optional` **formatTypeName**: NameFunction 57 | 58 | Function used to format the names of generated type. 59 | The function is passed in a name and must return a string that will be 60 | used in place of that name. 61 | 62 | Defined in: [src/main.ts:102](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L102) 63 | 64 | ___ 65 | 66 | ### includeImport 67 | 68 | • `Optional` **includeImport**: *boolean* 69 | 70 | Include code that imports the runtypes library in the generated code. 71 | When turned on, `import * as rt from "runtypes";` will be added at the 72 | top of the generated code. 73 | Default: true 74 | 75 | Defined in: [src/main.ts:69](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L69) 76 | 77 | ___ 78 | 79 | ### includeTypes 80 | 81 | • `Optional` **includeTypes**: *boolean* 82 | 83 | Generate type definitions in addition to runtype definitions. 84 | Default: true 85 | 86 | **`example`** 87 | 88 | When enabled: 89 | ``` 90 | const myRuntype = rt.Record({ name: rt.String }); 91 | ``` 92 | 93 | * When disabled: 94 | ``` 95 | const myRuntype = rt.Record({ name: rt.String }); 96 | type MyRuntype = rt.Static; 97 | ``` 98 | 99 | Defined in: [src/main.ts:88](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L88) 100 | 101 | ___ 102 | 103 | ### rejectCyclicDependencies 104 | 105 | • `Optional` **rejectCyclicDependencies**: *boolean* 106 | 107 | Whether to throw when encountering root types with cyclic dependencies, 108 | or emit possibly broken code for them. 109 | Default: false 110 | 111 | Defined in: [src/main.ts:109](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L109) 112 | 113 | ___ 114 | 115 | ### rejectUnknownNamedTypes 116 | 117 | • `Optional` **rejectUnknownNamedTypes**: *boolean* 118 | 119 | Whether to throw when encountering a named type that's not one of the, root 120 | types. Useful for caching typos when generating code. Must be disabled when 121 | using named types that are not part of the ones being generated. 122 | 123 | Default: false 124 | 125 | Defined in: [src/main.ts:118](https://github.com/cobraz/generate-runtypes/blob/7e14e87/src/main.ts#L118) 126 | -------------------------------------------------------------------------------- /docs/interfaces/main.prettieroptions.md: -------------------------------------------------------------------------------- 1 | [generate-runtypes](../README.md) / [main](../modules/main.md) / PrettierOptions 2 | 3 | # Interface: PrettierOptions 4 | 5 | [main](../modules/main.md).PrettierOptions 6 | 7 | ## Hierarchy 8 | 9 | - *Partial* 10 | 11 | ↳ **PrettierOptions** 12 | 13 | ## Table of contents 14 | 15 | ### Properties 16 | 17 | - [arrowParens](main.prettieroptions.md#arrowparens) 18 | - [bracketSpacing](main.prettieroptions.md#bracketspacing) 19 | - [embeddedInHtml](main.prettieroptions.md#embeddedinhtml) 20 | - [embeddedLanguageFormatting](main.prettieroptions.md#embeddedlanguageformatting) 21 | - [endOfLine](main.prettieroptions.md#endofline) 22 | - [filepath](main.prettieroptions.md#filepath) 23 | - [htmlWhitespaceSensitivity](main.prettieroptions.md#htmlwhitespacesensitivity) 24 | - [insertPragma](main.prettieroptions.md#insertpragma) 25 | - [jsxBracketSameLine](main.prettieroptions.md#jsxbracketsameline) 26 | - [jsxSingleQuote](main.prettieroptions.md#jsxsinglequote) 27 | - [parentParser](main.prettieroptions.md#parentparser) 28 | - [parser](main.prettieroptions.md#parser) 29 | - [plugins](main.prettieroptions.md#plugins) 30 | - [printWidth](main.prettieroptions.md#printwidth) 31 | - [proseWrap](main.prettieroptions.md#prosewrap) 32 | - [quoteProps](main.prettieroptions.md#quoteprops) 33 | - [rangeEnd](main.prettieroptions.md#rangeend) 34 | - [rangeStart](main.prettieroptions.md#rangestart) 35 | - [requirePragma](main.prettieroptions.md#requirepragma) 36 | - [semi](main.prettieroptions.md#semi) 37 | - [singleQuote](main.prettieroptions.md#singlequote) 38 | - [tabWidth](main.prettieroptions.md#tabwidth) 39 | - [trailingComma](main.prettieroptions.md#trailingcomma) 40 | - [useTabs](main.prettieroptions.md#usetabs) 41 | - [vueIndentScriptAndStyle](main.prettieroptions.md#vueindentscriptandstyle) 42 | 43 | ## Properties 44 | 45 | ### arrowParens 46 | 47 | • `Optional` **arrowParens**: ``"always"`` \| ``"avoid"`` 48 | 49 | Include parentheses around a sole arrow function parameter. 50 | 51 | **`default`** 'always' 52 | 53 | Inherited from: Partial.arrowParens 54 | 55 | Defined in: node_modules/@types/prettier/index.d.ts:139 56 | 57 | ___ 58 | 59 | ### bracketSpacing 60 | 61 | • `Optional` **bracketSpacing**: *boolean* 62 | 63 | Print spaces between brackets in object literals. 64 | 65 | **`default`** true 66 | 67 | Inherited from: Partial.bracketSpacing 68 | 69 | Defined in: node_modules/@types/prettier/index.d.ts:91 70 | 71 | ___ 72 | 73 | ### embeddedInHtml 74 | 75 | • `Optional` **embeddedInHtml**: *boolean* 76 | 77 | Inherited from: Partial.embeddedInHtml 78 | 79 | Defined in: node_modules/@types/prettier/index.d.ts:613 80 | 81 | ___ 82 | 83 | ### embeddedLanguageFormatting 84 | 85 | • `Optional` **embeddedLanguageFormatting**: ``"auto"`` \| ``"off"`` 86 | 87 | Control whether Prettier formats quoted code embedded in the file. 88 | 89 | **`default`** 'auto' 90 | 91 | Inherited from: Partial.embeddedLanguageFormatting 92 | 93 | Defined in: node_modules/@types/prettier/index.d.ts:168 94 | 95 | ___ 96 | 97 | ### endOfLine 98 | 99 | • `Optional` **endOfLine**: ``"auto"`` \| ``"lf"`` \| ``"crlf"`` \| ``"cr"`` 100 | 101 | Which end of line characters to apply. 102 | 103 | **`default`** 'lf' 104 | 105 | Inherited from: Partial.endOfLine 106 | 107 | Defined in: node_modules/@types/prettier/index.d.ts:153 108 | 109 | ___ 110 | 111 | ### filepath 112 | 113 | • `Optional` **filepath**: *string* 114 | 115 | Specify the input filepath. This will be used to do parser inference. 116 | 117 | Inherited from: Partial.filepath 118 | 119 | Defined in: node_modules/@types/prettier/index.d.ts:114 120 | 121 | ___ 122 | 123 | ### htmlWhitespaceSensitivity 124 | 125 | • `Optional` **htmlWhitespaceSensitivity**: ``"css"`` \| ``"strict"`` \| ``"ignore"`` 126 | 127 | How to handle whitespaces in HTML. 128 | 129 | **`default`** 'css' 130 | 131 | Inherited from: Partial.htmlWhitespaceSensitivity 132 | 133 | Defined in: node_modules/@types/prettier/index.d.ts:148 134 | 135 | ___ 136 | 137 | ### insertPragma 138 | 139 | • `Optional` **insertPragma**: *boolean* 140 | 141 | Prettier can insert a special @format marker at the top of files specifying that 142 | the file has been formatted with prettier. This works well when used in tandem with 143 | the --require-pragma option. If there is already a docblock at the top of 144 | the file then this option will add a newline to it with the @format marker. 145 | 146 | **`default`** false 147 | 148 | Inherited from: Partial.insertPragma 149 | 150 | Defined in: node_modules/@types/prettier/index.d.ts:128 151 | 152 | ___ 153 | 154 | ### jsxBracketSameLine 155 | 156 | • `Optional` **jsxBracketSameLine**: *boolean* 157 | 158 | Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line. 159 | 160 | **`default`** false 161 | 162 | Inherited from: Partial.jsxBracketSameLine 163 | 164 | Defined in: node_modules/@types/prettier/index.d.ts:96 165 | 166 | ___ 167 | 168 | ### jsxSingleQuote 169 | 170 | • `Optional` **jsxSingleQuote**: *boolean* 171 | 172 | Use single quotes in JSX. 173 | 174 | **`default`** false 175 | 176 | Inherited from: Partial.jsxSingleQuote 177 | 178 | Defined in: node_modules/@types/prettier/index.d.ts:81 179 | 180 | ___ 181 | 182 | ### parentParser 183 | 184 | • `Optional` **parentParser**: *string* 185 | 186 | Inherited from: Partial.parentParser 187 | 188 | Defined in: node_modules/@types/prettier/index.d.ts:612 189 | 190 | ___ 191 | 192 | ### parser 193 | 194 | • `Optional` **parser**: ``"angular"`` \| ``"babel-flow"`` \| ``"babel-ts"`` \| ``"babel"`` \| ``"css"`` \| ``"espree"`` \| ``"flow"`` \| ``"glimmer"`` \| ``"graphql"`` \| ``"html"`` \| ``"json-stringify"`` \| ``"json"`` \| ``"json5"`` \| ``"less"`` \| ``"lwc"`` \| ``"markdown"`` \| ``"mdx"`` \| ``"meriyah"`` \| ``"scss"`` \| ``"typescript"`` \| ``"vue"`` \| ``"yaml"`` \| *Pick* & { `_?`: *never* } \| CustomParser 195 | 196 | Specify which parser to use. 197 | 198 | Inherited from: Partial.parser 199 | 200 | Defined in: node_modules/@types/prettier/index.d.ts:110 201 | 202 | ___ 203 | 204 | ### plugins 205 | 206 | • `Optional` **plugins**: (*string* \| *Plugin*)[] 207 | 208 | The plugin API is in a beta state. 209 | 210 | Inherited from: Partial.plugins 211 | 212 | Defined in: node_modules/@types/prettier/index.d.ts:143 213 | 214 | ___ 215 | 216 | ### printWidth 217 | 218 | • `Optional` **printWidth**: *number* 219 | 220 | Specify the line length that the printer will wrap on. 221 | 222 | **`default`** 80 223 | 224 | Inherited from: Partial.printWidth 225 | 226 | Defined in: node_modules/@types/prettier/index.d.ts:601 227 | 228 | ___ 229 | 230 | ### proseWrap 231 | 232 | • `Optional` **proseWrap**: ``"never"`` \| ``"always"`` \| ``"preserve"`` 233 | 234 | By default, Prettier will wrap markdown text as-is since some services use a linebreak-sensitive renderer. 235 | In some cases you may want to rely on editor/viewer soft wrapping instead, so this option allows you to opt out. 236 | 237 | **`default`** 'preserve' 238 | 239 | Inherited from: Partial.proseWrap 240 | 241 | Defined in: node_modules/@types/prettier/index.d.ts:134 242 | 243 | ___ 244 | 245 | ### quoteProps 246 | 247 | • `Optional` **quoteProps**: ``"preserve"`` \| ``"as-needed"`` \| ``"consistent"`` 248 | 249 | Change when properties in objects are quoted. 250 | 251 | **`default`** 'as-needed' 252 | 253 | Inherited from: Partial.quoteProps 254 | 255 | Defined in: node_modules/@types/prettier/index.d.ts:158 256 | 257 | ___ 258 | 259 | ### rangeEnd 260 | 261 | • `Optional` **rangeEnd**: *number* 262 | 263 | Format only a segment of a file. 264 | 265 | **`default`** Infinity 266 | 267 | Inherited from: Partial.rangeEnd 268 | 269 | Defined in: node_modules/@types/prettier/index.d.ts:106 270 | 271 | ___ 272 | 273 | ### rangeStart 274 | 275 | • `Optional` **rangeStart**: *number* 276 | 277 | Format only a segment of a file. 278 | 279 | **`default`** 0 280 | 281 | Inherited from: Partial.rangeStart 282 | 283 | Defined in: node_modules/@types/prettier/index.d.ts:101 284 | 285 | ___ 286 | 287 | ### requirePragma 288 | 289 | • `Optional` **requirePragma**: *boolean* 290 | 291 | Prettier can restrict itself to only format files that contain a special comment, called a pragma, at the top of the file. 292 | This is very useful when gradually transitioning large, unformatted codebases to prettier. 293 | 294 | **`default`** false 295 | 296 | Inherited from: Partial.requirePragma 297 | 298 | Defined in: node_modules/@types/prettier/index.d.ts:120 299 | 300 | ___ 301 | 302 | ### semi 303 | 304 | • `Optional` **semi**: *boolean* 305 | 306 | Print semicolons at the ends of statements. 307 | 308 | **`default`** true 309 | 310 | Inherited from: Partial.semi 311 | 312 | Defined in: node_modules/@types/prettier/index.d.ts:71 313 | 314 | ___ 315 | 316 | ### singleQuote 317 | 318 | • `Optional` **singleQuote**: *boolean* 319 | 320 | Use single quotes instead of double quotes. 321 | 322 | **`default`** false 323 | 324 | Inherited from: Partial.singleQuote 325 | 326 | Defined in: node_modules/@types/prettier/index.d.ts:76 327 | 328 | ___ 329 | 330 | ### tabWidth 331 | 332 | • `Optional` **tabWidth**: *number* 333 | 334 | Specify the number of spaces per indentation-level. 335 | 336 | **`default`** 2 337 | 338 | Inherited from: Partial.tabWidth 339 | 340 | Defined in: node_modules/@types/prettier/index.d.ts:606 341 | 342 | ___ 343 | 344 | ### trailingComma 345 | 346 | • `Optional` **trailingComma**: ``"none"`` \| ``"es5"`` \| ``"all"`` 347 | 348 | Print trailing commas wherever possible. 349 | 350 | **`default`** 'es5' 351 | 352 | Inherited from: Partial.trailingComma 353 | 354 | Defined in: node_modules/@types/prettier/index.d.ts:86 355 | 356 | ___ 357 | 358 | ### useTabs 359 | 360 | • `Optional` **useTabs**: *boolean* 361 | 362 | Indent lines with tabs instead of spaces 363 | 364 | **`default`** false 365 | 366 | Inherited from: Partial.useTabs 367 | 368 | Defined in: node_modules/@types/prettier/index.d.ts:611 369 | 370 | ___ 371 | 372 | ### vueIndentScriptAndStyle 373 | 374 | • `Optional` **vueIndentScriptAndStyle**: *boolean* 375 | 376 | Whether or not to indent the code inside