public/awesome-cordova-plugins
public/awesome-cordova-plugins
9
0
Fork 0
forked from github/awesome-cordova-plugins
Code Pull Requests Activity

chore(docs): new approach to parsing npmid

Browse Source
This commit is contained in:
Ibby 2017-03-23 18:20:10 -04:00
parent 261e9cc249
commit cd5ff68bc1
4 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
scripts/docs/dgeni-config.js
View File

@ -16,14 +16,14 @@ module.exports = function(currentVersion) {
return new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage])
// .processor(require('./processors/latest-version'))
.processor(require('./processors/jekyll'))
.processor(require('./processors/remove-private-members'))
.processor(require('./processors/hide-private-api'))
.processor(require('./processors/collect-inputs-outputs'))
.processor(require('./processors/npm-id'))
// .processor(require('./processors/collect-inputs-outputs'))
.processor(require('./processors/parse-optional'))
.processor(require('./processors/npm-id'))
.processor(require('./processors/jekyll'))
// for debugging docs
// for debugging docs
// .processor(function test(){
// return {
//

3
scripts/docs/dgeni-readmes-config.js
View File

@ -19,9 +19,10 @@ module.exports = function(currentVersion) {
// .processor(require('./processors/latest-version'))
.processor(require('./processors/readmes'))
.processor(require('./processors/npm-id'))
.processor(require('./processors/remove-private-members'))
.processor(require('./processors/hide-private-api'))
.processor(require('./processors/npm-id'))
// .processor(require('./processors/collect-inputs-outputs'))
// for debugging docs

3
scripts/docs/processors/jekyll.js
View File

@ -5,6 +5,9 @@ module.exports = function jekyll(renderDocsProcessor) {
$runAfter: ['paths-computed'],
$runBefore: ['rendering-docs'],
$process: function(docs) {
console.log('jekyll running');
var currentVersion = renderDocsProcessor.extraData.version.current.name;
// pretty up and sort the docs object for menu generation

8
scripts/docs/processors/npm-id.js
View File

@ -2,7 +2,7 @@ module.exports = function npmId(renderDocsProcessor) {
return {
name: 'npm-id',
$runAfter: ['paths-computed'],
$runBefore: ['jekyll'],
$runBefore: ['rendering-docs'],
$process: function(docs) {
var currentVersion = renderDocsProcessor.extraData.version.current.name;
@ -12,10 +12,8 @@ module.exports = function npmId(renderDocsProcessor) {
});
docs.forEach(function(doc, i) {
doc.npmId = doc.outputPath.replace('/README.md', '') // for readmes
.replace('@ionic-native/plugins/','') // for readmes
.replace('content/docs/v2/native/', '') // for docs
.replace('/index.md', ''); // for docs
doc.npmId = doc.id.match(/plugins\/(.*)\/index/)[1];
console.log('@ionic-native/' + doc.npmId);
});
// returning docs will replace docs object in the next process