| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -19,21 +19,20 @@ const patternlab = require('@pattern-lab/core')(config); | |||
| 19 | 19 | Build thoughtful, pattern-driven user interfaces using atomic design principles. | |
| 20 | 20 | Many of these functions are exposed to users within [Editions](https://github.com/pattern-lab/patternlab-node#editions), but [direct consumption](https://github.com/pattern-lab/patternlab-node#direct-consumption) is also encouraged. | |
| 21 | 21 | ||
| 22 | - **Kind**: global namespace | ||
| 22 | + **Kind**: global namespace | ||
| 23 | 23 | **See** | |
| 24 | 24 | ||
| 25 | 25 | - [patternlab.io](patternlab.io) for more documentation. | |
| 26 | 26 | - [https://github.com/pattern-lab/patternlab-node](https://github.com/pattern-lab/patternlab-node) for code, issues, and releases | |
| 27 | 27 | ||
| 28 | - **License**: MIT | ||
| 28 | + **License**: MIT | ||
| 29 | 29 | ||
| 30 | 30 | * [`patternlab`](#patternlab) : <code>object</code> | |
| 31 | 31 | * _instance_ | |
| 32 | 32 | * [`.version`](#patternlab+version) ⇒ <code>string</code> | |
| 33 | 33 | * [`.build`](#patternlab+build) ⇒ <code>Promise</code> | |
| 34 | 34 | * [`.getDefaultConfig`](#patternlab+getDefaultConfig) ⇒ <code>object</code> | |
| 35 | 35 | * [`.getSupportedTemplateExtensions`](#patternlab+getSupportedTemplateExtensions) ⇒ <code>Array.<string></code> | |
| 36 | - * [`.installplugin`](#patternlab+installplugin) ⇒ <code>void</code> | ||
| 37 | 36 | * [`.liststarterkits`](#patternlab+liststarterkits) ⇒ <code>Promise</code> | |
| 38 | 37 | * [`.loadstarterkit`](#patternlab+loadstarterkit) ⇒ <code>void</code> | |
| 39 | 38 | * [`.patternsonly`](#patternlab+patternsonly) ⇒ <code>Promise</code> | |
@@ -51,17 +50,17 @@ Many of these functions are exposed to users within [Editions](https://github.co | |||
| 51 | 50 | ### `patternlab.version` ⇒ <code>string</code> | |
| 52 | 51 | Returns current version | |
| 53 | 52 | ||
| 54 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 55 | - **Returns**: <code>string</code> - current patternlab-node version as defined in `package.json`, as string | ||
| 53 | + **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 54 | + **Returns**: <code>string</code> - current patternlab-node version as defined in `package.json`, as string | ||
| 56 | 55 | <a name="patternlab+build"></a> | |
| 57 | 56 | ||
| 58 | 57 | ### `patternlab.build` ⇒ <code>Promise</code> | |
| 59 | 58 | Builds patterns, copies assets, and constructs user interface | |
| 60 | 59 | ||
| 61 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 62 | - **Returns**: <code>Promise</code> - a promise fulfilled when build is complete | ||
| 63 | - **Emits**: <code>event:PATTERNLAB_BUILD_START</code>, <code>event:PATTERNLAB_BUILD_END</code> | ||
| 64 | - **See**: [all events](./events.md) | ||
| 60 | + **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 61 | + **Returns**: <code>Promise</code> - a promise fulfilled when build is complete | ||
| 62 | + **Emits**: <code>event:PATTERNLAB_BUILD_START</code>, <code>event:PATTERNLAB_BUILD_END</code> | ||
| 63 | + **See**: [all events](./events.md) | ||
| 65 | 64 | ||
| 66 | 65 | | Param | Type | Default | Description | | |
| 67 | 66 | | --- | --- | --- | --- | | |
@@ -75,39 +74,29 @@ Builds patterns, copies assets, and constructs user interface | |||
| 75 | 74 | ### `patternlab.getDefaultConfig` ⇒ <code>object</code> | |
| 76 | 75 | Returns the standardized default config used to run Pattern Lab. This method can be called statically or after instantiation. | |
| 77 | 76 | ||
| 78 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 79 | - **Returns**: <code>object</code> - Returns the object representation of the `patternlab-config.json` | ||
| 77 | + **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 78 | + **Returns**: <code>object</code> - Returns the object representation of the `patternlab-config.json` | ||
| 80 | 79 | <a name="patternlab+getSupportedTemplateExtensions"></a> | |
| 81 | 80 | ||
| 82 | 81 | ### `patternlab.getSupportedTemplateExtensions` ⇒ <code>Array.<string></code> | |
| 83 | 82 | Returns all file extensions supported by installed PatternEngines | |
| 84 | 83 | ||
| 85 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 86 | - **Returns**: <code>Array.<string></code> - all supported file extensions | ||
| 87 | - <a name="patternlab+installplugin"></a> | ||
| 88 | - | ||
| 89 | - ### `patternlab.installplugin` ⇒ <code>void</code> | ||
| 90 | - Installs plugin already available via `node_modules/` | ||
| 91 | - | ||
| 92 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 93 | - | ||
| 94 | - | Param | Type | Description | | ||
| 95 | - | --- | --- | --- | | ||
| 96 | - | pluginName | <code>string</code> | name of plugin | | ||
| 84 | + **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 85 | + **Returns**: <code>Array.<string></code> - all supported file extensions | ||
| 97 | 86 | ||
| 98 | 87 | <a name="patternlab+liststarterkits"></a> | |
| 99 | 88 | ||
| 100 | 89 | ### `patternlab.liststarterkits` ⇒ <code>Promise</code> | |
| 101 | 90 | Fetches starterkit repositories from pattern-lab github org that contain 'starterkit' in their name | |
| 102 | 91 | ||
| 103 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 104 | - **Returns**: <code>Promise</code> - Returns an Array<{name,url}> for the starterkit repos | ||
| 92 | + **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 93 | + **Returns**: <code>Promise</code> - Returns an Array<{name,url}> for the starterkit repos | ||
| 105 | 94 | <a name="patternlab+loadstarterkit"></a> | |
| 106 | 95 | ||
| 107 | 96 | ### `patternlab.loadstarterkit` ⇒ <code>void</code> | |
| 108 | 97 | Loads starterkit already available via `node_modules/` | |
| 109 | 98 | ||
| 110 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 99 | + **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 111 | 100 | ||
| 112 | 101 | | Param | Type | Description | | |
| 113 | 102 | | --- | --- | --- | | |
@@ -119,8 +108,8 @@ Loads starterkit already available via `node_modules/` | |||
| 119 | 108 | ### `patternlab.patternsonly` ⇒ <code>Promise</code> | |
| 120 | 109 | Builds patterns only, leaving existing user interface files intact | |
| 121 | 110 | ||
| 122 | - **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 123 | - **Returns**: <code>Promise</code> - a promise fulfilled when build is complete | ||
| 111 | + **Kind**: instance property of [<code>patternlab</code>](#patternlab) | ||
| 112 | + **Returns**: <code>Promise</code> - a promise fulfilled when build is complete | ||
| 124 | 113 | ||
| 125 | 114 | | Param | Type | Default | Description | | |
| 126 | 115 | | --- | --- | --- | --- | | |
@@ -133,21 +122,21 @@ Builds patterns only, leaving existing user interface files intact | |||
| 133 | 122 | ### `patternlab.getDefaultConfig` ⇒ <code>object</code> | |
| 134 | 123 | Static method that returns the standardized default config used to run Pattern Lab. This method can be called statically or after instantiation. | |
| 135 | 124 | ||
| 136 | - **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 137 | - **Returns**: <code>object</code> - Returns the object representation of the `patternlab-config.json` | ||
| 125 | + **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 126 | + **Returns**: <code>object</code> - Returns the object representation of the `patternlab-config.json` | ||
| 138 | 127 | <a name="patternlab.getVersion"></a> | |
| 139 | 128 | ||
| 140 | 129 | ### `patternlab.getVersion` ⇒ <code>string</code> | |
| 141 | 130 | Static method that returns current version | |
| 142 | 131 | ||
| 143 | - **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 144 | - **Returns**: <code>string</code> - current @pattern-lab/core version as defined in `package.json` | ||
| 132 | + **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 133 | + **Returns**: <code>string</code> - current @pattern-lab/core version as defined in `package.json` | ||
| 145 | 134 | <a name="patternlab.server"></a> | |
| 146 | 135 | ||
| 147 | 136 | ### `patternlab.server` : <code>object</code> | |
| 148 | 137 | Server module | |
| 149 | 138 | ||
| 150 | - **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 139 | + **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 151 | 140 | ||
| 152 | 141 | * [`.server`](#patternlab.server) : <code>object</code> | |
| 153 | 142 | * [`.serve(options)`](#patternlab.server.serve) ⇒ <code>Promise</code> | |
@@ -159,8 +148,8 @@ Server module | |||
| 159 | 148 | #### `server.serve(options)` ⇒ <code>Promise</code> | |
| 160 | 149 | Build patterns, copies assets, and constructs user interface. Watches configured `source/` directories, and serves all output locally | |
| 161 | 150 | ||
| 162 | - **Kind**: static method of [<code>server</code>](#patternlab.server) | ||
| 163 | - **Returns**: <code>Promise</code> - a promise fulfilled when build is complete | ||
| 151 | + **Kind**: static method of [<code>server</code>](#patternlab.server) | ||
| 152 | + **Returns**: <code>Promise</code> - a promise fulfilled when build is complete | ||
| 164 | 153 | ||
| 165 | 154 | | Param | Type | Default | Description | | |
| 166 | 155 | | --- | --- | --- | --- | | |
@@ -174,19 +163,19 @@ Build patterns, copies assets, and constructs user interface. Watches configured | |||
| 174 | 163 | #### `server.reload()` ⇒ <code>Promise</code> | |
| 175 | 164 | Reloads any active live-server instances | |
| 176 | 165 | ||
| 177 | - **Kind**: static method of [<code>server</code>](#patternlab.server) | ||
| 178 | - **Returns**: <code>Promise</code> - a promise fulfilled when operation is complete | ||
| 166 | + **Kind**: static method of [<code>server</code>](#patternlab.server) | ||
| 167 | + **Returns**: <code>Promise</code> - a promise fulfilled when operation is complete | ||
| 179 | 168 | <a name="patternlab.server.refreshCSS"></a> | |
| 180 | 169 | ||
| 181 | 170 | #### `server.refreshCSS()` ⇒ <code>Promise</code> | |
| 182 | 171 | Reloads CSS on any active live-server instances | |
| 183 | 172 | ||
| 184 | - **Kind**: static method of [<code>server</code>](#patternlab.server) | ||
| 185 | - **Returns**: <code>Promise</code> - a promise fulfilled when operation is complete | ||
| 173 | + **Kind**: static method of [<code>server</code>](#patternlab.server) | ||
| 174 | + **Returns**: <code>Promise</code> - a promise fulfilled when operation is complete | ||
| 186 | 175 | <a name="patternlab.events"></a> | |
| 187 | 176 | ||
| 188 | 177 | ### `patternlab.events` : <code>EventEmitter</code> | |
| 189 | - **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 178 | + **Kind**: static property of [<code>patternlab</code>](#patternlab) | ||
| 190 | 179 | **See** | |
| 191 | 180 | ||
| 192 | 181 | - [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -204,21 +204,6 @@ const patternlab_module = function(config) { | |||
| 204 | 204 | return patternlab.getSupportedTemplateExtensions(); | |
| 205 | 205 | }, | |
| 206 | 206 | ||
| 207 | - /** | ||
| 208 | - * Installs plugin already available as a package dependency | ||
| 209 | - * | ||
| 210 | - * @memberof patternlab | ||
| 211 | - * @name installplugin | ||
| 212 | - * @instance | ||
| 213 | - * @param {string} pluginName name of plugin | ||
| 214 | - * @returns {void} | ||
| 215 | - */ | ||
| 216 | - installplugin: function(pluginName) { | ||
| 217 | - const plugin_manager = new pm(); | ||
| 218 | - | ||
| 219 | - plugin_manager.install_plugin(pluginName); | ||
| 220 | - }, | ||
| 221 | - | ||
| 222 | 207 | /** | |
| 223 | 208 | * Fetches starterkit repositories from pattern-lab github org that contain 'starterkit' in their name | |
| 224 | 209 | * | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -65,8 +65,4 @@ gulp.task('patternlab:serve', function() { | |||
| 65 | 65 | }); | |
| 66 | 66 | }); | |
| 67 | 67 | ||
| 68 | - gulp.task('patternlab:installplugin', function() { | ||
| 69 | - patternlab.installplugin(argv.plugin); | ||
| 70 | - }); | ||
| 71 | - | ||
| 72 | 68 | gulp.task('default', ['patternlab:help']); | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -62,8 +62,4 @@ gulp.task('patternlab:serve', function() { | |||
| 62 | 62 | }); | |
| 63 | 63 | }); | |
| 64 | 64 | ||
| 65 | - gulp.task('patternlab:installplugin', function() { | ||
| 66 | - patternlab.installplugin(argv.plugin); | ||
| 67 | - }); | ||
| 68 | - | ||
| 69 | 65 | gulp.task('default', ['patternlab:help']); | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1988,6 +1988,14 @@ | |||
| 1988 | 1988 | dependencies: | |
| 1989 | 1989 | "@types/node" ">= 8" | |
| 1990 | 1990 | ||
| 1991 | + "@pattern-lab/starterkit-handlebars-vanilla@1.4.0": | ||
| 1992 | + version "1.4.0" | ||
| 1993 | + resolved "https://registry.yarnpkg.com/@pattern-lab/starterkit-handlebars-vanilla/-/starterkit-handlebars-vanilla-1.4.0.tgz#aac144d0c21d40226f90ac5ce1b5d8505dddf330" | ||
| 1994 | + integrity sha512-inkcRhpYfm0q58zEQ9Gx2S+iVu+prAtRgqLw5Opd0MYC74NMcqN9XrcbJva4NfLn1tgx9dkA3Xmtg0IxiTHnAw== | ||
| 1995 | + dependencies: | ||
| 1996 | + node-sass "^4.12.0" | ||
| 1997 | + node-sass-glob-importer "^5.3.2" | ||
| 1998 | + | ||
| 1991 | 1999 | "@pattern-lab/starterkit-mustache-base@3.0.3": | |
| 1992 | 2000 | version "3.0.3" | |
| 1993 | 2001 | resolved "https://registry.yarnpkg.com/@pattern-lab/starterkit-mustache-base/-/starterkit-mustache-base-3.0.3.tgz#8ce9bc8e0d2254ee970a09c4bdc76d4f6131c91d" | |
@@ -12550,6 +12558,13 @@ node-releases@^1.1.38: | |||
| 12550 | 12558 | dependencies: | |
| 12551 | 12559 | semver "^6.3.0" | |
| 12552 | 12560 | ||
| 12561 | + node-sass-glob-importer@^5.3.2: | ||
| 12562 | + version "5.3.2" | ||
| 12563 | + resolved "https://registry.yarnpkg.com/node-sass-glob-importer/-/node-sass-glob-importer-5.3.2.tgz#465581e46027c0e9520e6d87f7e6eda858a14acb" | ||
| 12564 | + integrity sha512-QTX7KPsISgp55REV6pMH703nzHfWCOEYEQC0cDyTRo7XO6WDvyC0OAzekuQ4gs505IZcxv9KxZ3uPJ5s5H9D3g== | ||
| 12565 | + dependencies: | ||
| 12566 | + node-sass-magic-importer "^5.3.2" | ||
| 12567 | + | ||
| 12553 | 12568 | node-sass-magic-importer@^5.3.2: | |
| 12554 | 12569 | version "5.3.2" | |
| 12555 | 12570 | resolved "https://registry.yarnpkg.com/node-sass-magic-importer/-/node-sass-magic-importer-5.3.2.tgz#2f2248bb2e5cdb275ba34102ebf995edadf99175" | |
@@ -12572,7 +12587,7 @@ node-sass-selector-importer@^5.2.0: | |||
| 12572 | 12587 | node-sass-magic-importer "^5.3.2" | |
| 12573 | 12588 | postcss-scss "^2.0.0" | |
| 12574 | 12589 | ||
| 12575 | - node-sass@^4.14.1: | ||
| 12590 | + node-sass@^4.12.0, node-sass@^4.14.1: | ||
| 12576 | 12591 | version "4.14.1" | |
| 12577 | 12592 | resolved "https://registry.yarnpkg.com/node-sass/-/node-sass-4.14.1.tgz#99c87ec2efb7047ed638fb4c9db7f3a42e2217b5" | |
| 12578 | 12593 | integrity sha512-sjCuOlvGyCJS40R8BscF5vhVlQjNN069NtQ1gSxyK1u9iqvn6tf7O1R4GNowVZfiZUCRt5MmMs1xd+4V/7Yr0g== | |
| Back | FazBrowse Home | New Git URL |
0 commit comments