Implement TypeScript codegen (#479)

Author: ZimmerA

MANIFEST.in

@@ -2,6 +2,7 @@ include gittaggers.py Makefile LICENSE.txt requirements.txt mypy-requirements.tx
 include schema_salad/py.typed
 include schema_salad/avro/*
 recursive-include schema_salad/java *
+recursive-include schema_salad/typescript *
 include schema_salad/tests/*
 include schema_salad/tests/test_schema/*.md
 include schema_salad/tests/test_schema/*.yml

Makefile

@@ -51,7 +51,7 @@ install-dependencies: FORCE
 	pip install --upgrade $(DEVPKGS)
 	pip install -r requirements.txt -r mypy-requirements.txt -r docs/requirements.txt
 
-## install     : install the ${MODULE} module and schema-salad-tool
+## install     : install the ${MODULE} module and script(s)
 install: FORCE
 	pip install .$(EXTRAS)
 
@@ -168,7 +168,7 @@ list-author-emails:
 	@git log --format='%aN,%aE' | sort -u | grep -v 'root'
 
 mypy3: mypy
-mypy: $(filter-out setup.py gittagger.py,$(PYSOURCES))
+mypy: $(filter-out setup.py,$(PYSOURCES))
 	if ! test -f $(shell python3 -c 'import ruamel.yaml; import os.path; print(os.path.dirname(ruamel.yaml.__file__))')/py.typed ; \
 	then \
 		rm -Rf typeshed/ruamel/yaml ; \

lgtm.yml

@@ -0,0 +1,9 @@
+extraction: 
+  # Define settings for JavaScript analysis
+  ##########################################
+  javascript:
+    # The `index` step extracts information from the files in the codebase.
+    index:
+      # Specify a list of files and folders to exclude from extraction.
+      exclude:
+        - schema_salad/typescript/

schema_salad/codegen.py

@@ -13,11 +13,13 @@
 )
 from urllib.parse import urlsplit
 
+
 from . import schema
 from .codegen_base import CodeGenBase
 from .exceptions import SchemaSaladException
 from .java_codegen import JavaCodeGen
 from .python_codegen import PythonCodeGen
+from .typescript_codegen import TypeScriptCodeGen
 from .ref_resolver import Loader
 from .schema import shortname
 from .utils import aslist
@@ -68,6 +70,8 @@ def codegen(
             package=pkg,
             copyright=copyright,
         )
+    elif lang == "typescript":
+        gen = TypeScriptCodeGen(base, target=target, package=pkg, examples=examples)
     else:
         raise SchemaSaladException(f"Unsupported code generation language '{lang}'")
 

schema_salad/main.py

@@ -94,7 +94,8 @@ def arg_parser() -> argparse.ArgumentParser:
         "--codegen",
         type=str,
         metavar="language",
-        help="Generate classes in target language, currently supported: python, java",
+        help="Generate classes in target language, currently supported: "
+        "python, java, typescript",
     )
 
     parser.add_argument(

schema_salad/tests/test_typescript_codegen.py

@@ -0,0 +1,76 @@
+import shutil
+from pathlib import Path
+from typing import Any, Dict, List, Optional, cast
+
+from schema_salad import codegen, ref_resolver
+from schema_salad.schema import load_schema
+
+from .util import get_data
+
+
+def test_cwl_gen(tmp_path: Path) -> None:
+    topmed_example_path = get_data(
+        "tests/test_real_cwl/topmed/topmed_variant_calling_pipeline.cwl"
+    )
+    assert topmed_example_path
+    target_dir = tmp_path / "target"
+    examples_dir = tmp_path / "examples"
+
+    target_dir.mkdir()
+    examples_dir.mkdir()
+    shutil.copyfile(topmed_example_path, examples_dir / "valid_topmed.cwl")
+
+    typescript_codegen(cwl_file_uri, target_dir, examples=examples_dir)
+    package_json_path = target_dir / "package.json"
+    assert package_json_path.exists
+    tests_dir = target_dir / "src" / "test"
+    assert tests_dir.exists()
+    with open(tests_dir / "ExampleTest.ts") as f:
+        assert "topmed" in f.read()
+
+
+def test_meta_schema_gen(tmp_path: Path) -> None:
+    target_dir = tmp_path / "target"
+    target_dir.mkdir()
+    typescript_codegen(metaschema_file_uri, target_dir)
+    package_json_path = target_dir / "package.json"
+    assert package_json_path.exists()
+    src_dir = target_dir / "src"
+    assert src_dir.exists()
+    record_schema_dir = src_dir / "RecordSchema.ts"
+    assert record_schema_dir.exists()
+    with open(record_schema_dir) as f:
+        assert (
+            "export class RecordSchema extends Saveable implements "
+            "Internal.RecordSchemaProperties {\n" in f.read()
+        )
+
+
+def get_data_uri(resource_path: str) -> str:
+    path = get_data(resource_path)
+    assert path
+    return ref_resolver.file_uri(path)
+
+
+cwl_file_uri = get_data_uri("tests/test_schema/CommonWorkflowLanguage.yml")
+metaschema_file_uri = get_data_uri("metaschema/metaschema.yml")
+
+
+def typescript_codegen(
+    file_uri: str, target: Path, examples: Optional[Path] = None
+) -> None:
+    document_loader, avsc_names, schema_metadata, metaschema_loader = load_schema(
+        file_uri
+    )
+    schema_raw_doc = metaschema_loader.fetch(file_uri)
+    schema_doc, schema_metadata = metaschema_loader.resolve_all(
+        schema_raw_doc, file_uri
+    )
+    codegen.codegen(
+        "typescript",
+        cast(List[Dict[str, Any]], schema_doc),
+        schema_metadata,
+        document_loader,
+        target=str(target),
+        examples=str(examples) if examples else None,
+    )

schema_salad/typescript/.gitignore

@@ -0,0 +1,106 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+built/