{"id":15010630,"url":"https://github.com/vbauer/lein-typescript","last_synced_at":"2025-04-09T18:34:40.497Z","repository":{"id":29350837,"uuid":"32885050","full_name":"vbauer/lein-typescript","owner":"vbauer","description":"A Leiningen plugin for running TypeScript compiler","archived":false,"fork":false,"pushed_at":"2018-11-14T06:18:23.000Z","size":31,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-23T20:37:15.340Z","etag":null,"topics":["clj","clojure","javascript","js","lein","leiningen","typescript","typescript-compiler"],"latest_commit_sha":null,"homepage":null,"language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vbauer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-25T19:04:38.000Z","updated_at":"2020-11-16T14:50:23.000Z","dependencies_parsed_at":"2022-08-19T18:40:26.579Z","dependency_job_id":null,"html_url":"https://github.com/vbauer/lein-typescript","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vbauer","download_url":"https://codeload.github.com/vbauer/lein-typescript/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248088281,"owners_count":21045677,"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":["clj","clojure","javascript","js","lein","leiningen","typescript","typescript-compiler"],"created_at":"2024-09-24T19:35:09.005Z","updated_at":"2025-04-09T18:34:40.475Z","avatar_url":"https://github.com/vbauer.png","language":"Clojure","readme":"lein-typescript\n=================\n\n[![Build Status](https://travis-ci.org/vbauer/lein-typescript.svg?branch=master)](https://travis-ci.org/vbauer/lein-typescript)\n[![Clojars Project](https://img.shields.io/clojars/v/lein-typescript.svg)](https://clojars.org/lein-typescript)\n\n\u003e **TypeScript** is a free and open source programming language developed and maintained by Microsoft. It is a strict superset of JavaScript, and adds optional static typing and class-based object-oriented programming to the language. - [Wikipedia](https://en.wikipedia.org/wiki/TypeScript)\n\n[lein-typescript](https://github.com/vbauer/lein-typescript) is a Leiningen plugin that allows to use TypeScript compiler.\n\n\nPre-requirements\n================\n\nInstall [NodeJS](http://nodejs.org/) and [NPM](https://github.com/npm/npm) (package manager for Node) to install TypeScript:\n\n* On Ubuntu: `sudo apt-get install nodejs`\n* On Mac OS X: `brew install node`\n\n\nInstallation\n============\n\nInstall [TypeScript](https://www.npmjs.org/package/typescript) to use lein-typescript plugin. It could be done in few ways:\n\n* Use NPM to install TypeScript globally: `npm install typescript -g`\n* You can also install TypeScript in the current directory: `npm install typescript`\n* Use [lein-npm](https://github.com/bodil/lein-npm) plugin: `lein npm install`\n* Use just Leiningen: `lein deps`\n\nTo enable lein-typescript for your project, put the following in the :plugins vector of your project.clj file:\n\n```clojure\n; Use latest version instead of \"X.X.X\"\n:plugins [[lein-typescript \"X.X.X\"]]\n```\n\n\nConfiguration\n=============\n\nTo configure lein-typescript, put the :typescript parameter in the file project.clj. It could be a single configuration (simple map) or a collection of configurations (for multiple configuration).\n\n```clojure\n:typescript {\n  :sources [\"*.ts\" \"resources/*.ts\"]\n  :excludes [\"bad.ts\"]\n  :out \"app.js\"\n  :declaration true\n  :remove-comments true\n  :target :es5\n}\n```\n\n\nConfiguration parameters\n------------------------\n\u003cdl\u003e\n\n  \u003cdt\u003e:sources\u003c/dt\u003e\n  \u003cdd\u003eList of input TypeScript sources. It is possible to use a single source or a vector of sources. To configure this parameter, you could also use a \u003ca href=\"http://en.wikipedia.org/wiki/Glob_(programming)\"\u003eGlob Patterns\u003c/a\u003e.\u003c/dd\u003e\n\n  \u003cdt\u003e:excludes\u003c/dt\u003e\n  \u003cdd\u003eList of glob patterns to prevent processing of some files. It is also possible to use both variants: single pattern and collection of patterns.\u003c/dd\u003e\n\n  \u003cdt\u003e:out-dir\u003c/dt\u003e\n  \u003cdd\u003eRedirect output structure to the specified directory (it is undefined by default). \":out\" parameter will be used in priority.\u003c/dd\u003e\n\n  \u003cdt\u003e:out\u003c/dt\u003e\n  \u003cdd\u003eConcatenate and emit output to single file which you can specify using this parameter (it is undefined by default).\u003c/dd\u003e\n\n  \u003cdt\u003e:remove-comments\u003c/dt\u003e\n  \u003cdd\u003eDo not emit comments to output (default value is \"false\").\u003c/dd\u003e\n\n  \u003cdt\u003e:declaration\u003c/dt\u003e\n  \u003cdd\u003eGenerates corresponding \".d.ts\" file (default value is \"false\").\u003c/dd\u003e\n\n  \u003cdt\u003e:source-map\u003c/dt\u003e\n  \u003cdd\u003eGenerates corresponding '.map' file (default is \"false\").\u003c/dd\u003e\n\n  \u003cdt\u003e:module\u003c/dt\u003e\n  \u003cdd\u003eSpecify module code generation: :commonjs or :amd (it is undefined by default).\u003c/dd\u003e\n\n  \u003cdt\u003e:target\u003c/dt\u003e\n  \u003cdd\u003eSpecify ECMAScript target version: :es3 (default), :es5, or :es6 (experimental).\u003c/dd\u003e\n\n  \u003cdt\u003e:watch\u003c/dt\u003e\n  \u003cdd\u003eWatch input files. It could be helpful to use this parameter with \u003ca href=\"https://github.com/Raynes/lein-pdo\"\u003elein-pdo\u003c/a\u003e and/or with separate profile (default is \"false\").\u003c/dd\u003e\n\n\u003c/dl\u003e\n\n\nHooks\n-----\n\nTo enable this plugin in the compile stage, use the following hook:\n```clojure\n:hooks [lein-typescript.plugin]\n```\n\n\nUsage\n=====\n\nTo compile TypeScript files using configuration from project.clj, you should use: `lein typescript`.\nIt is also possible to use short alias for `typescript` task: `lein ts`.\n\nTo show help: `lein help typescript`\n\n\nExample project\n===============\n\nJust clone the current repository and try to play with [example project](https://github.com/vbauer/lein-typescript/tree/master/example) for better understanding how to use lein-typescript.\n\n\nThanks to\n=========\n\n[Microsoft Corporation](http://www.microsoft.com), [Anders Hejlsberg](https://github.com/ahejlsberg) and [TypeScript community](https://github.com/Microsoft/TypeScript) for the great programming language.\n\n\n\nMight also like\n===============\n\n* [lein-coffeescript](https://github.com/vbauer/lein-coffeescript) - a Leiningen plugin for running CoffeeScript compiler.\n* [lein-jslint](https://github.com/vbauer/lein-jslint) - a Leiningen plugin for running javascript code through JSLint.\n* [lein-jshint](https://github.com/vbauer/lein-jshint) - a Leiningen plugin for running javascript code through JSHint.\n* [lein-plantuml](https://github.com/vbauer/lein-plantuml) - a Leiningen plugin for generating UML diagrams using PlantUML.\n* [lein-asciidoctor](https://github.com/asciidoctor/asciidoctor-lein-plugin) - A Leiningen plugin for generating documentation using Asciidoctor.\n* [jabberjay](https://github.com/vbauer/jabberjay) - a simple framework for creating Jabber bots.\n* [coderwall-clj](https://github.com/vbauer/coderwall-clj) - a tiny CoderWall client for Clojure.\n\n\nLicense\n=======\n\nCopyright © 2015 Vladislav Bauer\n\nDistributed under the Eclipse Public License, the same as Clojure.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvbauer%2Flein-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvbauer%2Flein-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvbauer%2Flein-typescript/lists"}