feat: generator updates

packages/json-schema-generator/src/generator/compile-schema.js

@@ -1,11 +1,13 @@
 import {createGenerator} from 'ts-json-schema-generator';
 import {getValidatableTypes} from './get-validatable-types.js';
-import {JSONSchema7} from 'json-schema';
 
 /**
  * Compile the JSON schema for a path
+ * @param path {string}
+ * @param tsconfig {string}
+ * @returns {[schema: import('json-schema').JSONSchema7, type: string]}
  */
-export function compileSchema(path: string, tsconfig: string): [schma: JSONSchema7, type: string] {
+export function compileSchema(path, tsconfig) {
   const generator = createGenerator({
     path,
     tsconfig,

packages/json-schema-generator/src/generator/get-validatable-types.js

@@ -2,10 +2,13 @@ import {ts} from 'ts-json-schema-generator';
 
 /**
  * Get all types with `@validatable` annotations
+ * @param program {ts.Program}
+ * @returns {Set<string>}
  */
-export function getValidatableTypes(program: ts.Program) {
+export function getValidatableTypes(program) {
   const checker = program.getTypeChecker();
-  const declarationNames = new Set<string>();
+  /** @type {Set<string>} */
+  const declarationNames = new Set();
 
   for (const sourceFile of program.getSourceFiles()) {
     const sourceFileSymbol = checker.getSymbolAtLocation(sourceFile);
@@ -27,8 +30,10 @@ export function getValidatableTypes(program: ts.Program) {
 
 /**
  * Type predicate for if a JSDoc tag is `@validatable`
+ * @param tag {ts.JSDocTag}
+ * @returns {tag is ts.JSDocTag}
  */
 // eslint-disable-next-line unicorn/prevent-abbreviations
-function isValidatableJSDocTag(tag: ts.JSDocTag): tag is ts.JSDocTag {
+function isValidatableJSDocTag(tag) {
   return tag.tagName.escapedText === 'validatable';
 }

packages/json-schema-generator/src/index.js

@@ -1,11 +1,7 @@
 import {compileSchema} from './generator/compile-schema.js';
-import {generateFiles, Plugin, PluginContext} from '@openstapps/tsup-plugin';
-import {JSONSchema7} from 'json-schema';
-import {Plugin as EsbuildPlugin} from 'esbuild';
+import {generateFiles} from '@openstapps/tsup-plugin';
 import {createGenerator} from 'ts-json-schema-generator';
 
-export type SchemaConsumer = (this: PluginContext, schema: JSONSchema7) => Record<string, string | Buffer>;
-
 /**
  * ESBuild Plugin for directly importing schemas
  *
@@ -19,13 +15,16 @@ export type SchemaConsumer = (this: PluginContext, schema: JSONSchema7) => Recor
  * interface Bar {}
  * // ./schema-consumer.ts
  * import {default as barSchema} from 'schema:./my-type.js#Bar'
+ *
+ * @type {import('esbuild').Plugin}
  */
-export const esbuildJsonSchemaPlugin: EsbuildPlugin = {
+export const esbuildJsonSchemaPlugin = {
   name: 'json-schema',
   setup(build) {
     const fileRegex = /^schema:/;
     const namespace = 'json-schema-ns';
-    const schemas = new Map<string, string>();
+    /** @type {Map<string, string>} */
+    const schemas = new Map();
 
     build.onResolve({filter: fileRegex}, ({path, importer}) => {
       const [from, name] = path.replace(fileRegex, '').split('#', 1);
@@ -56,22 +55,22 @@ export const esbuildJsonSchemaPlugin: EsbuildPlugin = {
 
 /**
  * TSUp plugin for generating JSONSchema files
- * @param schemaName the name of the generated schema
- * @param schemaConsumers any consumers that can directly use the schema
+ * @param schemaName {string} the name of the generated schema
+ * @param schemaConsumers {Array<[string, import('./types.js').SchemaConsumer]>} any consumers
+ * that can directly use the schema
+ * @returns {import('@openstapps/tsup-plugin').Plugin}
  */
-export function jsonSchemaPlugin(
-  schemaName: string,
-  ...schemaConsumers: Array<[string, SchemaConsumer]>
-): Plugin {
+export function jsonSchemaPlugin(schemaName, ...schemaConsumers) {
   return {
     name: 'json-schema-generator',
     async buildEnd() {
-      let schema: JSONSchema7;
+      /** @type {import('json-schema').JSONSchema7} */
+      let schema;
       await generateFiles('JSON-Schema', async function () {
-        const [jsonSchema, types] = compileSchema(
-          (this.options.entry as string[])[0],
-          this.options.tsconfig!,
-        );
+        if (!this.options.tsconfig) throw new Error('Must supply a tsconfig');
+        if (!Array.isArray(this.options.entry)) throw new Error('Must supply entry as an array');
+
+        const [jsonSchema, types] = compileSchema(this.options.entry[0], this.options.tsconfig);
         schema = jsonSchema;
 
         return {

packages/json-schema-generator/src/types.d.ts

@@ -0,0 +1,6 @@
+import {JSONSchema7} from 'json-schema';
+import {PluginContext} from '@openstapps/tsup-plugin/src/types.js';
+
+export type SchemaConsumer = (this: PluginContext, schema: JSONSchema7) => Record<string, string | Buffer>;
+
+export {compileSchema, jsonSchemaPlugin, esbuildJsonSchemaPlugin} from './index.js';