Skip to content
This repository was archived by the owner on May 26, 2023. It is now read-only.

Commit 7466fa2

Browse files
Portugal, Marcelomportuga
authored andcommitted
fix(task name): Rename task from uidocs to uidocs-generator
This is needed to allow for jit-grunt support and other tools like it. BREAKING CHANGE: Renamed grunt task from uidocs to uidocs-generator.
1 parent 8d4c460 commit 7466fa2

File tree

8 files changed

+11
-12
lines changed

8 files changed

+11
-12
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,3 @@ node_modules
22
*.sublime-*
33
.idea
44
.tmp
5-
docs

Gruntfile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module.exports = function (grunt) {
3131
},
3232
all: ['spec/']
3333
},
34-
uidocs: {
34+
'uidocs-generator': {
3535
options: {
3636
title: 'grunt-uidocs-example',
3737
html5Mode: false

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,15 @@ Inside your `Gruntfile.js` file, add a section named *uidocs*.
3131
Here's a simple example:
3232

3333
```js
34-
uidocs: {
34+
uidocs-generator: {
3535
all: ['src/**/*.js']
3636
}
3737
```
3838

3939
And with many options:
4040

4141
```js
42-
uidocs: {
42+
uidocs-generator: {
4343
options: {
4444
dest: 'docs',
4545
scripts: ['../app.min.js'],

docs/js/docs-setup.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ UI_DOCS={
1111
"type": "overview",
1212
"moduleName": "Getting Started",
1313
"shortDescription": "Getting Started",
14-
"keywords": "absolute account add additional ads adsconfig advanced advantage ajax allow allows analytics anchor angular angular-animate api app application assumes attribute automatically awesome best bestmatch bootstrap build built button ca-pub-6177019177103290 cdn characters class clean client code command comment comments commit config content copied copy creates creating css current custom default deferload deleted dest destination dev directive directives directory discussions display distribution doc docs docsapp documentation don dropdown edit editexample editlink empty enable example examples extension extracts false field file filename files finally find folder form full function generated getcomputedstyle git github google grunt grunt-contrib-clean grunt-scripts grunt-uidocs-generator gruntfile grunttemplateprocess header highlight highlighted html html5mode http https image imagelink improve include inline inlinepartials input-block-level inside install io js json lazyloading link links list listitems lists live loaded loader loadnpmtasks location long longer marked match matching md menu min minified mode module modules named nav navbar navtemplate needed ng-model nice node_modules npm null open option optional options overview overwritten package parse parses partial partials path pkg place placeholders plugin png polyfill pre-processed prefixed project provided query rautogrow read reference relative remote repository requirejs resize return rfx rx-autogrow scripts search sections selected server services set shortname sidebar simple size slot source sourcelink spec src started startpage string styles supported system tag target targets task template templates text textarea thirdparty thirdpartypath title titlelink tmpl top true turn tutorial ua-08150815-0 uidocs update url values version view visible window work working works wraps",
14+
"keywords": "absolute account add additional ads adsconfig advanced advantage ajax allow allows analytics anchor angular angular-animate api app application assumes attribute automatically awesome best bestmatch bootstrap build built button ca-pub-6177019177103290 cdn characters class clean client code command comment comments commit config content copied copy creates creating css current custom default deferload deleted dest destination dev directive directives directory discussions display distribution doc docs docsapp documentation don dropdown edit editexample editlink empty enable example examples extension extracts false field file filename files finally find folder form full function generated getcomputedstyle git github google grunt grunt-contrib-clean grunt-scripts grunt-uidocs-generator gruntfile grunttemplateprocess header highlight highlighted html html5mode http https image imagelink improve include inline inlinepartials input-block-level inside install io js json lazyloading link links list listitems lists live loaded loader loadnpmtasks location long longer marked match matching md menu min minified mode module modules named nav navbar navtemplate needed ng-model nice node_modules npm null open option optional options overview overwritten package parse parses partial partials path pkg place placeholders plugin png polyfill pre-processed prefixed project provided query rautogrow read reference relative remote repository requirejs resize return rfx rx-autogrow scripts search sections selected server services set shortname sidebar simple size slot source sourcelink spec src started startpage string styles supported system tag target targets task template templates text textarea thirdparty thirdpartypath title titlelink tmpl top true turn tutorial ua-08150815-0 uidocs-generator update url values version view visible window work working works wraps",
1515
"isDeprecated": false
1616
},
1717
{

docs/partials/examples/01_GETTING_STARTED.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
<h3 id="getting-started_config">Config</h3>
1212
<p>Inside your <code>Gruntfile.js</code> file, add a section named <em>uidocs</em>.
1313
Here&#39;s a simple example:</p>
14-
<pre><code class="language-js">uidocs: {
14+
<pre><code class="language-js">uidocs-generator: {
1515
all: [&#39;src/**/*.js&#39;]
1616
}</code></pre>
1717
<p>And with many options:</p>
18-
<pre><code class="language-js">uidocs: {
18+
<pre><code class="language-js">uidocs-generator: {
1919
options: {
2020
dest: &#39;docs&#39;,
2121
scripts: [&#39;../app.min.js&#39;],

examples/01_GETTING_STARTED.uidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ Inside your `Gruntfile.js` file, add a section named *uidocs*.
2121
Here's a simple example:
2222

2323
```js
24-
uidocs: {
24+
uidocs-generator: {
2525
all: ['src/**/*.js']
2626
}
2727
```
2828

2929
And with many options:
3030

3131
```js
32-
uidocs: {
32+
uidocs-generator: {
3333
options: {
3434
dest: 'docs',
3535
scripts: ['../app.min.js'],

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
"homepage": "https://github.com/angular-ui/grunt-uidocs-generator",
1212
"bugs": "https://github.com/angular-ui/grunt-uidocs-generator/issues",
1313
"scripts": {
14-
"build": "grunt clean uidocs",
15-
"start": "npm run build && grunt connect",
14+
"build": "grunt clean uidocs-generator",
15+
"start": "grunt clean uidocs-generator connect",
1616
"test": "grunt test",
1717
"preversion": "npm test",
1818
"version": "npm run build && grunt conventionalChangelog && git add -f docs/ CHANGELOG.md",

tasks/uidocs-generator.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ module.exports = (grunt) => {
2828
const unittest = {};
2929
const templates = path.resolve(__dirname, '../src/templates');
3030

31-
grunt.registerMultiTask('uidocs', 'build documentation', function() {
31+
grunt.registerMultiTask('uidocs-generator', 'build documentation', function() {
3232
var start = now(),
3333
pkg = getPackage(),
3434
done = this.async(),

0 commit comments

Comments
 (0)