Merge pull request #5 from typed-ember/set-up-release-it

Set up release infrastructure

Author: dfreeman

.release-it.yml

@@ -0,0 +1,8 @@
+repo: 'typed-ember/glint'
+github:
+  release: true
+  tokenRef: GITHUB_AUTH
+plugins:
+  release-it-yarn-workspaces: true
+  release-it-lerna-changelog:
+    editor: true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "glint",
-  "repository": "typed-ember/glint",
+  "repository": "https://github.com/typed-ember/glint",
   "private": true,
   "workspaces": [
     "packages/*",
@@ -19,6 +19,9 @@
     "@typescript-eslint/eslint-plugin": "^2.31.0",
     "@typescript-eslint/parser": "^2.31.0",
     "eslint": "^6.8.0",
-    "prettier": "^2.0.5"
+    "prettier": "^2.0.5",
+    "release-it": "^13.6.3",
+    "release-it-lerna-changelog": "^2.3.0",
+    "release-it-yarn-workspaces": "^1.4.0"
   }
 }

packages/cli/README.md

@@ -0,0 +1,17 @@
+# `@glint/cli`
+
+This package contains a CLI to execute template-aware typechecking on a [glint] project.
+
+[glint]: https://github.com/typed-ember/glint
+
+## Usage
+
+```sh
+glint [--watch|-w] [--declaration|-d] [--project path/to/tsconfig.json]
+```
+
+## Flags
+
+- `--watch` If passed, `glint` will perform a watched typecheck, re-checking your project as files change.
+- `--declaration` If passed, `glint` will emit `.d.ts` files according to the configuration in your `tsconfig.json`
+- `--project` Overrides where `glint` will look to find your project's `tsconfig.json`

packages/cli/package.json

@@ -14,7 +14,9 @@
   },
   "scripts": {
     "lint": "eslint . --ext ts --max-warnings 0 && prettier --check src",
-    "test": "jest"
+    "test": "jest",
+    "build": "tsc --build",
+    "prepack": "yarn build"
   },
   "dependencies": {
     "@glint/config": "link:../config",

packages/config/README.md

@@ -0,0 +1,24 @@
+# `@glint/config`
+
+This package is used by various other [glint] packages to locate any custom configuration.
+
+[glint]: https://github.com/typed-ember/glint
+
+## Config Specification
+
+`@glint/config` uses [`cosmiconfig`] to locate your configuration file, so several possible file formats/names are possible:
+
+- JSON in a `"glint"` key in your `package.json`
+- YAML or JSON in `.glintrc`, `.glintrc.yml` or `.glintrc.json`
+- JavaScript in `.glintrc.js` or `glint.config.js`
+
+[`cosmiconfig`]: https://github.com/davidtheclark/cosmiconfig
+
+Configuration will be searched upward starting from the directory in whicn your `tsconfig.json` is located.
+
+## Config Options
+
+- `include`: A glob or array of globs specifying, relative to the location of your config file, what files should be considered for template processing by glint. Default: `'**/*.ts'`.
+- `exclude`: A glob or array of globs specifying, relative to the location of your config file, what files should _not_ considered for template processing by glint. Default: `'**/node_modules/**'`.
+
+Note that if a file is matched by both `include` and `exclude`, it will be ignored.

packages/config/package.json

@@ -6,9 +6,15 @@
   "author": "Dan Freeman (https://github.com/dfreeman)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "files": [
+    "README.md",
+    "lib"
+  ],
   "scripts": {
     "lint": "eslint . --ext ts --max-warnings 0 && prettier --check src",
-    "test": "jest"
+    "test": "jest",
+    "build": "tsc --build",
+    "prepack": "yarn build"
   },
   "dependencies": {
     "cosmiconfig": "^6.0.0",

packages/template/README.md

@@ -0,0 +1,5 @@
+# `@glint/template`
+
+This package contains type declarations used by other [glint] packages for perfoming TypeScript analysis of Glimmer templates. These types determine the semantics of component/modifier/helper invocations.
+
+[glint]: https://github.com/typed-ember/glint

packages/template/package.json

@@ -9,6 +9,11 @@
     "lint": "eslint . --ext ts --max-warnings 0 && prettier --check .",
     "test": "tsc --project __tests__"
   },
+  "files": [
+    "README.md",
+    "-private",
+    "*.d.ts"
+  ],
   "devDependencies": {
     "@glimmer/component": "^1.0.0",
     "@glimmerx/component": "^0.2.2",

packages/transform/README.md

@@ -0,0 +1,5 @@
+# `@glint/transform`
+
+This package contains tools for rewriting Glimmer templates as a TypeScript approximation of their semantics, used by other [glint] packages.
+
+[glint]: https://github.com/typed-ember/glint

packages/transform/package.json

@@ -6,9 +6,15 @@
   "author": "Dan Freeman (https://github.com/dfreeman)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "files": [
+    "README.md",
+    "lib"
+  ],
   "scripts": {
     "lint": "eslint . --ext ts --max-warnings 0 && prettier --check src",
-    "test": "jest"
+    "test": "jest",
+    "build": "tsc --build",
+    "prepack": "yarn build"
   },
   "dependencies": {
     "@babel/core": "^7.9.0",

packages/tsserver-plugin/README.md

@@ -0,0 +1,6 @@
+# `@glint/tsserver-plugin`
+
+This package contains a TypeScript [language service plugin] to present [glint] diagnostics for Glimmer templates, as well as enabling quick info, symbol renaming, jump-to-definition and limited autocomplete in template contexts.
+
+[language service plugin]: https://github.com/microsoft/TypeScript/wiki/Writing-a-Language-Service-Plugin
+[glint]: https://github.com/typed-ember/glint

packages/tsserver-plugin/package.json

@@ -5,9 +5,16 @@
   "license": "MIT",
   "author": "Dan Freeman (https://github.com/dfreeman)",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "README.md",
+    "lib"
+  ],
   "scripts": {
     "lint": "eslint . --ext ts --max-warnings 0 && prettier --check src",
-    "test": "jest"
+    "test": "jest",
+    "build": "tsc --build",
+    "prepack": "yarn build"
   },
   "dependencies": {
     "@glint/config": "link:../config",