chore: add Type deprecation to schemata script

jacob-alford · Feb 13, 2023 · 054290a · 054290a
1 parent 7be43b5
commit 054290a
Showing 1 changed file with 22 additions and 10 deletions.
diff --git a/scripts/generate-schemables.ts b/scripts/generate-schemables.ts
@@ -118,16 +118,16 @@ const makeSchemableExtContents: (
         ),
       ),
 
-      instanceComment('1.0.0'),
+      instanceComment('Schemable', '1.0.0'),
       makeSchemableExtTypeclass(schemables, ''),
 
-      instanceComment('1.0.0'),
+      instanceComment('Schemable', '1.0.0'),
       makeSchemableExtTypeclass(schemables, '1'),
 
-      instanceComment('1.0.0'),
+      instanceComment('Schemable', '1.0.0'),
       makeSchemableExtTypeclass(schemables, '2'),
 
-      instanceComment('1.0.0'),
+      instanceComment('Schemable', '1.0.0'),
       makeSchemableExtTypeclass(schemables, '2C'),
     ],
     _.createNodeArray,
@@ -156,6 +156,7 @@ export type SchemableTypeclasses =
   | SchemableTypeclass<'Arbitrary', 'Arb', 'SchemableExt1', '1.0.0'>
   | SchemableTypeclass<'Printer', 'P', 'SchemableExt2', '1.1.0'>
   | SchemableTypeclass<'JsonSchema', 'JS', 'SchemableExt2', '1.2.0'>
+  | SchemableTypeclass<'Schemable', '_', 'SchemableExt2', '1.0.0'>
 
 // #region Typeclass modules
 
@@ -164,11 +165,18 @@ export const moduleHeaderComment: (module: string, version: string) => ts.JSDoc
   version,
 ) =>
   _.createJSDocComment(
-    `SchemableExt instances for ${module}\n\n**Warning: DO NOT EDIT, this module is autogenerated**\n\n@since ${version}`,
+    `SchemableExt instances for ${module}\n\n**Warning: DO NOT EDIT, this module is autogenerated**\n\n${
+      module === 'Type' ? `@deprecated\n` : ''
+    }@since ${version}`,
   )
 
-export const instanceComment: (version: SchemableTypeclasses[3]) => ts.JSDoc = verision =>
-  _.createJSDocComment(`@since ${verision}\n@category Instances`)
+export const instanceComment: (
+  module: SchemableTypeclasses[0],
+  version: SchemableTypeclasses[3],
+) => ts.JSDoc = (module, version) =>
+  _.createJSDocComment(
+    `${module === 'Type' ? '@deprecated\n' : ''}@since ${version}\n@category Instances`,
+  )
 
 const makeInstanceTypeExport: (tc: SchemableTypeclasses) => ts.ExportDeclaration = ([
   typeclassName,
@@ -183,7 +191,9 @@ const makeInstanceTypeExport: (tc: SchemableTypeclasses) => ts.ExportDeclaration
       ts.addSyntheticLeadingComment(
         _.createExportSpecifier(false, undefined, _.createIdentifier(typeclassName)),
         ts.SyntaxKind.MultiLineCommentTrivia,
-        `* @since ${version}\n\n@category Model`,
+        `* ${
+          typeclassName === 'Type' ? '@deprecated\n' : ''
+        }@since ${version}\n\n@category Model`,
         true,
       ),
     ]),
@@ -263,7 +273,9 @@ const makeInterpreter: (typeclass: SchemableTypeclasses) => ts.VariableStatement
       ),
     ),
     ts.SyntaxKind.MultiLineCommentTrivia,
-    `* @since ${version}\n\n@category Interpreters`,
+    `* ${
+      module === 'Type' ? '@deprecated\n' : ''
+    }@since ${version}\n\n@category Interpreters`,
     true,
   )
 
@@ -299,7 +311,7 @@ const makeSchemableInstanceModuleContents: (
         ),
       ),
       makeInstanceTypeExport(typeclass),
-      instanceComment(sinceVersion),
+      instanceComment(module, sinceVersion),
       makeSchemableInstance(typeclass, schemables),
       makeInterpreter(typeclass),
     ],