Upgrading eslint-typegen 0.0 to 0.1
Review needed0.0.2 → 0.1.6New3Changed3Fixed5
Review neededUpgrade verdict
3 behavior changes.
In plain terms
- The package now uses a lighter library to turn JSON schemas into TypeScript types.
- The tool that generates code now runs more efficiently.
- The code this tool generates is now more efficient.
Must act Nothing to change
No breaking, platform, security or deprecated items in this range.
Adds json-schema-to-typescript-lite ^14.0.0, ohash ^1.1.3.
Drops json-schema, json-schema-to-typescript.
Installs 9 packages in all (was 55).
Also installs @apidevtools/json-schema-ref-parser.
No longer installs @bcherny/json-schema-ref-parser, @types/glob, @types/lodash, @types/minimatch, @types/node, @types/prettier, any-promise, balanced-match, brace-expansion, call-me-maybe, cli-color, concat-map, d, es5-ext, es6-iterator and 32 more.
Nothing in this upgrade needs a code or configuration change.
API changes
Generated by DepDelta from published .d.ts files. Not mixed with prose notes.
- added:
function compileRule(name: string, rule: Rule.RuleModule, compileOptions?: Partial<Options>): Promise<{ name: string; jsdoc: string[]; typeName: string; typeDeclarations: string[] }> - added:
function flatConfigsToPlugins(configs: Linter.FlatConfig[], options?: FlatConfigsToPluginsOptions): Promise<Record<string, ESLint.Plugin>> - added:
function flatConfigsToRulesDTS(configs: Linter.FlatConfig[], options?: FlatConfigsToRulesOptions): Promise<string> - added:
function pluginsToRulesDTS(plugins: Record<string, ESLint.Plugin>, options?: RulesTypeGenOptions): Promise<string> - added:
interface FlatConfigsToPluginsOptions - added:
interface FlatConfigsToRulesOptions extends RulesTypeGenOptions, FlatConfigsToPluginsOptions - added:
interface RulesTypeGenOptions - added:
property FlatConfigsToPluginsOptions.filterConfig?: (config: Linter.FlatConfig) => boolean - added:
property FlatConfigsToPluginsOptions.filterPlugin?: (name: string, plugin: ESLint.Plugin) => boolean - added:
property RulesTypeGenOptions.compileOptions?: Partial<Options> - added:
property RulesTypeGenOptions.exportTypeName?: string - added:
property RulesTypeGenOptions.includeAugmentation?: boolean - added:
property RulesTypeGenOptions.includeIgnoreComments?: boolean - added:
property RulesTypeGenOptions.includeTypeImports?: boolean
- removed:
function pluginsToRulesOptions(plugins: Record<string, ESLint.Plugin>): Promise<string> - removed:
function ruleToOptions(name: string, rule: Rule.RuleModule): Promise<{ name: string; typeName: string; typeDeclrations: never[]; jsdoc?: undefined } | { name: string; jsdoc: string[]; typeName: string; typeDeclrations: string[] }> - added:
function default(configs: Promise<Linter.FlatConfig[]> | Linter.FlatConfig[], options?: TypeGenOptions): Promise<Linter.FlatConfig[]> - added:
interface TypeGenOptions extends FlatConfigsToPluginsOptions - added:
property TypeGenOptions.dtsPath?: string