TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-12-24 03:14:03 +03:00
Code Issues Projects Releases Wiki Activity

Added JSDoc comments into package-json lib

Browse Source
This commit is contained in:
Daniel Lockyer 2020-11-25 11:29:04 +00:00
parent 7f09052ba1
commit 6d42c391c5
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ghost/package-json/lib/package-json.js
View File

@ -63,6 +63,8 @@ module.exports = class PackageJson {
/**
* Parse package.json and validate it has
* all the required fields
*
* @param {string} path
*/
async parse(path) {
let source;
@ -105,6 +107,8 @@ module.exports = class PackageJson {
/**
* Recursively read directory and find the packages in it
*
* @param {string} absolutePath
* @param {string} packageName
* @returns {object}
*/
async processPackage(absolutePath, packageName) {
@ -127,6 +131,10 @@ module.exports = class PackageJson {
return pkg;
}
/**
* @param {string} packagePath
* @param {string} packageName
*/
async readPackage(packagePath, packageName) {
const absolutePath = join(packagePath, packageName);
@ -150,6 +158,9 @@ module.exports = class PackageJson {
}
}
/**
* @param {string} packagePath
*/
readPackages(packagePath) {
const self = this;