feature/decorators

.gitignore

@@ -6,3 +6,4 @@
 /lib
 /node_modules
 /tmp
+.idea

README.md

@@ -49,6 +49,36 @@ LS.run()
 .catch(require('@oclif/errors/handle'))
 ```
 
+**TypeScript and Decorators**
+```js
+#!/usr/bin/env ts-node
+
+import * as fs from 'fs'
+import {Command, flags, Flags} from '@oclif/command'
+
+@Flags({
+  version: flags.version(),
+  help: flags.help(),
+  // run with --dir= or -d=
+  dir: flags.string({
+    char: 'd',
+    default: process.cwd(),
+  }),
+})
+class LS extends Command {
+  async run() {
+    const {flags} = this.parse(LS)
+    let files = fs.readdirSync(flags.dir)
+    for (let f of files) {
+      this.log(f)
+    }
+  }
+}
+
+LS.run()
+.catch(require('@oclif/errors/handle'))
+```
+
 **JavaScript**
 ```js
 #!/usr/bin/env node
@@ -80,6 +110,37 @@ LS.run()
 .catch(require('@oclif/errors/handle'))
 ```
 
+**JavaScript and Decorators**
+```js
+#!/usr/bin/env node
+
+const fs = require('fs')
+const {Command, flags, Flags} = require('@oclif/command')
+
+class LS extends Command {
+  async run() {
+    const {flags} = this.parse(LS)
+    let files = fs.readdirSync(flags.dir)
+    for (let f of files) {
+      this.log(f)
+    }
+  }
+}
+
+Flags({
+  version: flags.version(),
+  help: flags.help(),
+  // run with --dir= or -d=
+  dir: flags.string({
+    char: 'd',
+    default: process.cwd(),
+  }),
+})(LS)
+
+LS.run()
+.catch(require('@oclif/errors/handle'))
+```
+
 Then run either of these with:
 
 ```sh-session

src/decorators.ts

@@ -0,0 +1,21 @@
+import Command from './command'
+
+export type CommandConstructor = typeof Command
+
+export const makeDecorator = <Field extends keyof CommandConstructor>(field: Field) =>
+  (value: CommandConstructor[Field]) =>
+    (target: CommandConstructor) => {
+      target[field] = value
+    }
+
+export const Description = makeDecorator('description')
+export const Hidden = makeDecorator('hidden')
+export const Usage = makeDecorator('usage')
+export const Help = makeDecorator('help')
+export const Aliases = makeDecorator('aliases')
+export const Strict = makeDecorator('strict')
+export const Parse = makeDecorator('parse')
+export const Flags = makeDecorator('flags')
+export const Args = makeDecorator('args')
+export const Examples = makeDecorator('plugin')
+export const ParserOptions = makeDecorator('parserOptions')

src/index.ts

@@ -29,3 +29,5 @@ export {
   Command,
   flags,
 }
+
+export * from './decorators'

tsconfig.json

@@ -10,7 +10,8 @@
       "./src"
     ],
     "strict": true,
-    "target": "es2017"
+    "target": "es2017",
+    "experimentalDecorators": true
   },
   "include": [
     "./src/**/*"