-
-
Save imaustink/f22e65791d3b874680b6c77550bebd32 to your computer and use it in GitHub Desktop.
Super mod: Update readme
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| var fs = require('fs'); | |
| var path = require('path'); | |
| var MODULE_DESC_REGEX = /<code>__can-.+__ <\/code>\n(.+)/m; | |
| var FALLBACK_MODULE_DESC_REGEX = /(?=\n[a-z]|\n[A-Z])\n(.+)/m | |
| module.exports = { | |
| getOptions: function () { | |
| return []; | |
| }, | |
| run: function (directory, opts) { | |
| var package = require(path.join(directory, 'package.json')); | |
| var name = package.name; | |
| return Promise.all([ | |
| getMDFileByName(directory, 'readme'), | |
| getMDFileByName(directory, 'license') | |
| ]).then(([readme, license]) => { | |
| if (!license) { | |
| console.error(`No license was not found at ${name}`); | |
| return Promise.resolve(); | |
| } | |
| return new Promise(function (resolve, reject) { | |
| if (!readme) { | |
| readme = path.join(directory, 'README.md'); | |
| return resolve(''); | |
| } | |
| fs.readFile(readme, {encoding: 'utf8'}, function (error, text) { | |
| error ? reject(error) : resolve(text); | |
| }); | |
| }).then(function (text) { | |
| var readme = getReadme(package, text, path.basename(license)); | |
| if (readme === text) { | |
| console.error('readme is already updated.'); | |
| } | |
| return readme; | |
| }).then(function (newText) { | |
| return new Promise(function (resolve, reject) { | |
| fs.writeFile(readme, newText, function (error) { | |
| error ? reject(error) : resolve(); | |
| }); | |
| }); | |
| }); | |
| }); | |
| } | |
| }; | |
| function getReadme(package, originalReadme, license){ | |
| var moduleName = package.name; | |
| var matches = originalReadme.match(MODULE_DESC_REGEX); | |
| var desc; | |
| if(matches && matches[1]){ | |
| desc = matches[1]; | |
| }else{ | |
| matches = originalReadme.match(FALLBACK_MODULE_DESC_REGEX); | |
| if(matches && matches[1] || package.description){ | |
| desc = matches && matches[1] || package.description; | |
| }else{ | |
| console.error(`Failed to parse original description of ${moduleName}!`); | |
| desc = 'FAILED TO GET DESCRIPTION'; | |
| } | |
| } | |
| return `# ${moduleName} | |
| [](https://gitter.im/canjs/canjs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | |
| [](https://github.com/canjs/${moduleName}/blob/master/${license}) | |
| [](https://www.npmjs.com/package/${moduleName}) | |
| [](https://travis-ci.org/canjs/${moduleName}) | |
| [](https://ci.appveyor.com/project/matthewp/${moduleName}) | |
| [](https://coveralls.io/github/canjs/${moduleName}?branch=master) | |
| [](https://greenkeeper.io/) | |
| ${desc} | |
| ## Documentation | |
| Read the [${moduleName} API docs on CanJS.com](https://canjs.com/doc/${moduleName}.html). | |
| ## Changelog | |
| See the [latest releases on GitHub](https://github.com/canjs/${moduleName}/releases). | |
| ## Contributing | |
| The [contribution guide](https://github.com/canjs/${moduleName}/blob/master/CONTRIBUTING.md) has information on getting help, reporting bugs, developing locally, and more. | |
| ## License | |
| [MIT](https://github.com/canjs/${moduleName}/blob/master/${license}) | |
| `; | |
| } | |
| function getMDFileByName(directory, name){ | |
| return new Promise((resolve, reject) => { | |
| fs.readdir(directory, (err, files) => { | |
| if(err) return reject(err); | |
| var fileName = files.find(item => { | |
| item = item.toLowerCase(); | |
| return item.startsWith(name) && (item.endsWith('md') || item.endsWith('markdown')) || item === name; | |
| }); | |
| resolve(fileName ? path.join(directory, fileName) : null); | |
| }); | |
| }); | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment