{"id":14155523,"url":"https://github.com/aws-cloudformation/cloudformation-cli-typescript-plugin","last_synced_at":"2025-04-08T03:14:51.663Z","repository":{"id":40774336,"uuid":"245881645","full_name":"aws-cloudformation/cloudformation-cli-typescript-plugin","owner":"aws-cloudformation","description":"The CloudFormation Provider Development Toolkit Node.js Plugin allows you to autogenerate TypeScript code based on an input schema.","archived":false,"fork":false,"pushed_at":"2024-04-23T17:11:47.000Z","size":600,"stargazers_count":35,"open_issues_count":29,"forks_count":14,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-04-27T06:04:13.073Z","etag":null,"topics":["aws-cloudformation","aws-resources","cloudformation-cli","javascript","nodejs","resource-provider","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aws-cloudformation.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-08T20:18:23.000Z","updated_at":"2024-05-31T18:55:47.856Z","dependencies_parsed_at":"2023-09-21T21:22:27.091Z","dependency_job_id":"64ed29a2-514a-4f98-a983-cf36d46acd6d","html_url":"https://github.com/aws-cloudformation/cloudformation-cli-typescript-plugin","commit_stats":{"total_commits":110,"total_committers":13,"mean_commits":8.461538461538462,"dds":0.4181818181818182,"last_synced_commit":"d989f2b48c4ebe9745fb5609ce2e9760505ef457"},"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-cloudformation%2Fcloudformation-cli-typescript-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-cloudformation%2Fcloudformation-cli-typescript-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-cloudformation%2Fcloudformation-cli-typescript-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-cloudformation%2Fcloudformation-cli-typescript-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aws-cloudformation","download_url":"https://codeload.github.com/aws-cloudformation/cloudformation-cli-typescript-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247767236,"owners_count":20992548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-cloudformation","aws-resources","cloudformation-cli","javascript","nodejs","resource-provider","typescript"],"created_at":"2024-08-17T08:03:46.241Z","updated_at":"2025-04-08T03:14:51.634Z","avatar_url":"https://github.com/aws-cloudformation.png","language":"TypeScript","funding_links":[],"categories":["typescript"],"sub_categories":[],"readme":"# AWS CloudFormation Resource Provider Typescript Plugin\n\nWe're excited to share our progress with adding new languages to the CloudFormation CLI!\n\n## AWS CloudFormation Resource Provider TypeScript Plugin\n\n[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/aws-cloudformation/cloudformation-cli-typescript-plugin/ci/master)](https://github.com/aws-cloudformation/cloudformation-cli-typescript-plugin/actions?query=branch%3Amaster+workflow%3Aci) [![Codecov](https://img.shields.io/codecov/c/gh/aws-cloudformation/cloudformation-cli-typescript-plugin)](https://codecov.io/gh/aws-cloudformation/cloudformation-cli-typescript-plugin) [![PyPI version](https://img.shields.io/pypi/v/cloudformation-cli-typescript-plugin)](https://pypi.org/project/cloudformation-cli-typescript-plugin) [![NPM version](https://img.shields.io/npm/v/@amazon-web-services-cloudformation/cloudformation-cli-typescript-lib)](https://www.npmjs.com/package/@amazon-web-services-cloudformation/cloudformation-cli-typescript-lib) [![Node.js version](https://img.shields.io/badge/dynamic/json?color=brightgreen\u0026url=https://raw.githubusercontent.com/aws-cloudformation/cloudformation-cli-typescript-plugin/master/package.json\u0026query=$.engines.node\u0026label=nodejs)](https://nodejs.org/)\n\nThe CloudFormation CLI (cfn) allows you to author your own resource providers that can be used by CloudFormation.\n\nThis plugin library helps to provide TypeScript runtime bindings for the execution of your providers by CloudFormation.\n\nUsage\n-----\n\nIf you are using this package to build resource providers for CloudFormation, install the [CloudFormation CLI TypeScript Plugin](https://github.com/aws-cloudformation/cloudformation-cli-typescript-plugin) - this will automatically install the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli)! A Python virtual environment is recommended.\n\n**Prerequisites**\n\n- Python version 3.6 or above\n- [SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)\n- Your choice of TypeScript IDE\n\n**Installation**\n\n\n```shell\npip3 install cloudformation-cli-typescript-plugin\n```\n\nRefer to the [CloudFormation CLI User Guide](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html) for the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) for usage instructions.\n\n**Howto**\n\nExample run:\n\n```\n$ cfn init\nInitializing new project\nWhat's the name of your resource type?\n(Organization::Service::Resource)\n\u003e\u003e Foo::Bar::Baz\nSelect a language for code generation:\n[1] java\n[2] typescript\n(enter an integer):\n\u003e\u003e 2\nUse docker for platform-independent packaging (Y/n)?\nThis is highly recommended unless you are experienced\nwith cross-platform Typescript packaging.\n\u003e\u003e y\nInitialized a new project in \u003c\u003e\n$ cfn submit --dry-run\n$ sam local invoke --event sam-tests/create.json TestEntrypoint\n```\n\nDevelopment\n-----------\n\nFor changes to the plugin, a Python virtual environment is recommended. Check out and install the plugin in editable mode:\n\n```shell\npython3 -m venv env\nsource env/bin/activate\npip3 install -e /path/to/cloudformation-cli-typescript-plugin\n```\n\nYou may also want to check out the [CloudFormation CLI](https://github.com/aws-cloudformation/cloudformation-cli) if you wish to make edits to that. In this case, installing them in one operation works well:\n\n```shell\npip3 install \\\n  -e /path/to/cloudformation-cli \\\n  -e /path/to/cloudformation-cli-typescript-plugin\n```\n\nThat ensures neither is accidentally installed from PyPI.\n\nFor changes to the typescript library \"@amazon-web-services-cloudformation/cloudformation-cli-typescript-lib\" pack up the compiled javascript:\n\n```shell\nnpm run build\nnpm pack\n```\n\nYou can then install this in a cfn resource project using:\n\n```shell\nnpm install ../path/to/cloudformation-cli-typescript-plugin/amazon-web-services-cloudformation-cloudformation-cli-typescript-lib-1.0.1.tgz\n```\n\nLinting and running unit tests is done via [pre-commit](https://pre-commit.com/), and so is performed automatically on commit after being installed (`pre-commit install`). The continuous integration also runs these checks. Manual options are available so you don't have to commit:\n\n```shell\n# run all hooks on all files, mirrors what the CI runs\npre-commit run --all-files\n# run unit tests only. can also be used for other hooks, e.g. black, flake8, pylint-local\npre-commit run pytest-local\n```\n\nLicense\n-------\n\nThis library is licensed under the Apache 2.0 License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws-cloudformation%2Fcloudformation-cli-typescript-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faws-cloudformation%2Fcloudformation-cli-typescript-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws-cloudformation%2Fcloudformation-cli-typescript-plugin/lists"}