MCPcopy Index your code
hub / github.com/jsdoc/jsdoc / buildSourceList

Function buildSourceList

cli.js:257–297  ·  view source on GitHub ↗
()

Source from the content-addressed store, hash-verified

255 }
256
257 function buildSourceList() {
258 const Readme = require('jsdoc/readme');
259
260 let packageJson;
261 let readmeHtml;
262 let sourceFile;
263 let sourceFiles = env.opts._ ? env.opts._.slice(0) : [];
264
265 if (env.conf.source && env.conf.source.include) {
266 sourceFiles = sourceFiles.concat(env.conf.source.include);
267 }
268
269 // load the user-specified package/README files, if any
270 if (env.opts.package) {
271 packageJson = readPackageJson(env.opts.package);
272 }
273 if (env.opts.readme) {
274 readmeHtml = new Readme(env.opts.readme).html;
275 }
276
277 // source files named `package.json` or `README.md` get special treatment, unless the user
278 // explicitly specified a package and/or README file
279 for (let i = 0, l = sourceFiles.length; i < l; i++) {
280 sourceFile = sourceFiles[i];
281
282 if ( !env.opts.package && /\bpackage\.json$/i.test(sourceFile) ) {
283 packageJson = readPackageJson(sourceFile);
284 sourceFiles.splice(i--, 1);
285 }
286
287 if ( !env.opts.readme && /(\bREADME|\.md)$/i.test(sourceFile) ) {
288 readmeHtml = new Readme(sourceFile).html;
289 sourceFiles.splice(i--, 1);
290 }
291 }
292
293 props.packageJson = packageJson;
294 env.opts.readme = readmeHtml;
295
296 return sourceFiles;
297 }
298
299 // TODO: docs
300 cli.scanFiles = () => {

Callers 1

cli.jsFile · 0.85

Calls 2

readPackageJsonFunction · 0.85
testMethod · 0.80

Tested by

no test coverage detected

Used in the wild real call sites across dependent graphs

searching dependent graphs…