@@ -35,30 +35,34 @@ first PR to the Ionic CLI. :heart_eyes:
3535
3636#### Structure
3737
38- Our CLI is organized into a monorepo. Common tools, such as Typescript and jest ,
38+ Our CLI is organized into a monorepo. Common tools, such as TypeScript and Jest ,
3939are installed in the base directory while package dependencies are each
4040installed in their respective ` packages/**/node_modules ` directories.
4141
4242Each ` packages/* ` folder represents a package on npm.
4343
44- * ` packages/ionic ` : Ionic CLI executable.
45- * ` packages/@ionic/cli-utils ` : Ionic CLI library and utilities.
46- * ` packages/@ionic/cli-plugin-* ` : Ionic CLI plugins.
47- * ` packages/@ionic/cli-framework ` : Framework for command-line programs.
48- * ` packages/@ionic/discover ` : Service discovery library used for ` ionic serve `
49- with the [ Ionic DevApp] ( https://ionicframework.com/docs/pro/devapp/ ) .
50- * ` packages/@ionic/schematics-angular ` : Ionic Angular v4+ schematics for `ionic
51- generate`.
52- * ` packages/@ionic/v1-toolkit ` : Utility CLI for Ionic v1 Apps, used by `ionic
53- serve`.
54- * ` packages/@ionic/lab ` : Utility CLI for Ionic Lab, used by ` ionic serve ` .
44+ * [ ` packages/ionic ` ] ( https://github.com/ionic-team/ionic-cli/tree/master/packages/ionic ) :
45+ Ionic CLI executable.
46+ * [ ` packages/@ionic/cli-utils ` ] ( https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/cli-utils ) :
47+ Ionic CLI library and utilities.
48+ * [ ` packages/@ionic/cli-framework ` ] ( https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/cli-framework ) :
49+ Framework for command-line programs.
50+ * [ ` packages/@ionic/discover ` ] ( https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/discover ) :
51+ Service discovery library used for ` ionic serve ` with the [ Ionic
52+ DevApp] ( https://ionicframework.com/docs/pro/devapp/ ) .
53+ * [ ` packages/@ionic/schematics-angular ` ] ( https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/schematics-angular ) :
54+ Ionic Angular v4+ schematics for ` ionic generate ` .
55+ * [ ` packages/@ionic/v1-toolkit ` ] ( https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/v1-toolkit ) :
56+ Utility CLI for Ionic v1 Apps, used by ` ionic serve ` .
57+ * [ ` packages/@ionic/lab ` ] ( https://github.com/ionic-team/ionic-cli/tree/master/packages/%40ionic/lab ) :
58+ Utility CLI for Ionic Lab, used by ` ionic serve ` .
5559
5660#### Toolset
5761
5862* npm 5 is required.
5963* Node 8+ is required.
60- * Our codebase is written in [ Typescript ] ( https://www.typescriptlang.org/ ) . If
61- you're unfamiliar with Typescript , we recommend using [ VS
64+ * Our codebase is written in [ TypeScript ] ( https://www.typescriptlang.org/ ) . If
65+ you're unfamiliar with TypeScript , we recommend using [ VS
6266 Code] ( https://code.visualstudio.com/ ) and finding a tutorial to familiarize
6367 yourself with basic concepts.
6468* Our test suite uses [ Jest] ( https://facebook.github.io/jest/ ) .
@@ -71,8 +75,8 @@ Each `packages/*` folder represents a package on npm.
7175 together)
72761 . Optionally ` npm run link ` to make ` ionic ` and other bin files point to your
7377 dev CLI.
74- 1 . ` npm run watch ` will spin up Typescript watch scripts for all packages.
75- 1 . Typescript source files are in ` packages/**/src ` .
78+ 1 . ` npm run watch ` will spin up TypeScript watch scripts for all packages.
79+ 1 . TypeScript source files are in ` packages/**/src ` .
76801 . Good luck! :muscle : Please open an issue if you have questions or something
7781 is unclear.
7882
@@ -96,10 +100,12 @@ $ npm install -g ionic
96100
97101TODO: Be helpful about where to look for commands, utilities, etc.
98102
99- ##### Publishing Notes
103+ ##### Publishing Steps
100104
101- Cancel any watch scripts before proceeding.
105+ 1 . Cancel any watch scripts.
106+ 1 . Write notable changes in the package(s)'s ` CHANGELOG.md ` file(s).
107+ 1 . For...
102108
103- * ** testing releases** : ` npm run publish:testing `
104- * ** canary releases** : ` npm run publish:canary `
105- * ** stable releases** : ` npm run publish `
109+ * ... testing releases: ` npm run publish:testing `
110+ * ... canary releases: ` npm run publish:canary `
111+ * ... stable releases: ` npm run publish `
0 commit comments