Type generation for SFDX projects
Last updated 11 days ago by heber .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install sfdx-typegen 
SYNC missed versions from official npm registry.


Type generation from SFDX project

Version CircleCI Appveyor CI Codecov Greenkeeper Known Vulnerabilities Downloads/week License

$ npm install -g sfdx-typegen
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
sfdx-typegen/0.5.1 win32-x64 node-v8.16.0
$ sfdx --help [COMMAND]
  $ sfdx COMMAND

sfdx <%= command.id %> [-f <string>] [-a <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

Generate component types that can be used in your controller and helper files to improve auto-complete and correctness

  $ sfdx typegen:aura:cmp [-f <string>] [-a <string>] [-o <string>] [--json] [--loglevel 

  -a, --apextypespath=apextypespath               [default: types/apex] Path to typing directory that holds compatible
                                                  types for AuraEnabled properties in Apex controllers and classes

  -f, --file=file                                 [default: force-app/**/aura/**/*.cmp] Glob pattern for cmp files

  -o, --output=output                             [default: .sfdx/typings/aura/] Path to typing output directory,
                                                  typically embedded in the project '.sfdx' directory

  --json                                          format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

  $ sfdx typegen:cmp --file force-app/**/aura/**/*.cmp
  $ sfdx typegen:cmp --file force-app/**/aura/**/*.cmp --apextypespath types/apex
  $ sfdx typegen:cmp --file force-app/main/default/aura/TestComponent/TestComponent.cmp

See code: lib\commands\typegen\aura\cmp.js

sfdx <%= command.id %> [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

Export types from existing Helper.ts files, should preserve typing information from the functions and properties and export to usable declarations

  $ sfdx typegen:aura:helper [-f <string>] [-o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal]

  -f, --file=file                                 [default: force-app/**/aura/**/*Helper.ts] Glob pattern for helper
                                                  typescript files, [force-app/**/aura/**/*Helper.ts]

  -o, --output=output                             [default: .sfdx/typings/aura] Path to an output destination for
                                                  generated d.ts files

  --json                                          format output as json

  --loglevel=(trace|debug|info|warn|error|fatal)  [default: warn] logging level for this command invocation

  $ sfdx typegen:helper
  $ sfdx typegen:helper --file force-app/**/aura/**/*Helper.ts
  $ sfdx typegen:helper --file force-app/main/default/aura/TestComponent/TestComponentHelper.cmp

See code: lib\commands\typegen\aura\helper.js

Current Tags

  • 0.5.1                                ...           latest (11 days ago)

8 Versions

  • 0.5.1                                ...           11 days ago
  • 0.5.0                                ...           11 days ago
  • 0.4.1                                ...           24 days ago
  • 0.4.0                                ...           a month ago
  • 0.3.0                                ...           a month ago
  • 0.2.0                                ...           a month ago
  • 0.1.1                                ...           2 months ago
  • 0.1.0                                ...           2 months ago
Maintainers (1)
Today 0
This Week 0
This Month 32
Last Day 0
Last Week 0
Last Month 105
Dependencies (9)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |