juisy 2.0.0-beta.0

package/template/bin/cli/lib/version/update-version.js

@@ -0,0 +1,51 @@
+const fs = require('fs')
+const path = require('path')
+const juisy = require('@hperchec/juisy')
+
+const {
+  rootDir,
+  $style,
+  error,
+  step,
+  substep,
+  run,
+  wait
+} = juisy.utils
+
+// File paths
+const filePaths = {
+  packageJson: path.resolve(rootDir, './package.json')
+}
+// Get package.json content
+const packageJson = require(filePaths.packageJson)
+
+/**
+ * Update version in necessary files
+ * @param {string} version - The version
+ * @return {void}
+ */
+module.exports = async function updateVersion (version) {
+  // Update version for each file
+  packageJson.version = version
+
+  /**
+   * Update files
+   */
+  step('Updating version in necessary files')
+  // Update package.json
+  try {
+    fs.writeFileSync(filePaths.packageJson, JSON.stringify(packageJson, null, 4), 'utf8')
+  } catch (e) {
+    error('Unable to update package.json file', e)
+  }
+  substep($style.green('✔ package.json successfuly updated'))
+  // Updating package-lock
+  await wait('Updating package-lock.json', async () => {
+    try {
+      await run('npm', [ 'install', '--prefer-offline' ], { stdio: 'pipe' })
+    } catch (e) {
+      error('Unable to update package-lock.json file', e)
+    }
+  })
+  substep($style.green('✔ package-lock.json successfuly updated'), { last: true })
+}

package/template/bin/scripts/commit-msg.js

@@ -0,0 +1,42 @@
+const juisy = require('@hperchec/juisy')
+
+const {
+  $style,
+  abort,
+  log,
+  rootDir,
+  step,
+  substep,
+  run
+} = juisy.utils
+
+/**
+ * commit-msg git hook
+ */
+;(async function () {
+  step('Git hook: commit-msg')
+
+  // Get git commit msg path from args
+  const args = process.argv.slice(2)
+  const gitMsgPath = args[0]
+
+  try {
+    // original is: npx --no -- commitlint --edit ${1}
+    // we replace "${1}" by gitMsgPath arg
+    await run('npx', [
+      '--no',
+      '--',
+      'commitlint',
+      '--edit',
+      gitMsgPath
+    ], { cwd: rootDir })
+  } catch (e) {
+    substep($style.red('❌ Git hook: "commit-msg" failed. Please check ./COMMIT_CONVENTION.md for more informations.'), { last: true })
+    abort(1) // Abort with error
+  }
+
+  // Everything is okay
+  substep($style.green('✔ Git hook: "commit-msg" passed'), { last: true })
+
+  log() // blank line
+})()

package/template/bin/scripts/pre-commit.js

@@ -0,0 +1,32 @@
+const juisy = require('@hperchec/juisy')
+
+const {
+  $style,
+  error,
+  log,
+  rootDir,
+  step,
+  substep,
+  run
+} = juisy.utils
+
+/**
+ * Pre commit git hook
+ */
+;(async function () {
+  step('Git hook: pre-commit')
+
+  try {
+    // npx lint-staged
+    await run('npx', [
+      'lint-staged'
+    ], { stdio: 'pipe', cwd: rootDir })
+  } catch (e) {
+    error('Git hook: "commit-msg" error: ', e)
+  }
+
+  // Everything is okay
+  substep($style.green('✔ Git hook: "pre-commit" passed'), { last: true })
+
+  log() // blank line
+})()

package/template/docs/api/docs.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  /**
+   * Dist directory (relative to root folder)
+   */
+  distDir: './docs/api',
+  /**
+   * Output directory (relative to distDir folder)
+   */
+  outputDir: 'output'
+}

package/template/docs/readme/config.js

@@ -0,0 +1,22 @@
+/**
+ * @hperchec/readme-generator Example configuration file
+ */
+
+const path = require('path')
+
+// Export configuration
+module.exports = {
+  // Template path
+  templatePath: path.resolve(__dirname, './template.md'), // Default template file
+  // Output path
+  outputPath: path.resolve(__dirname, '../../'), // Your project root directory by default
+  // Output file name
+  outputName: 'README.md', // 'README.md' by default
+  // Path to ejs data file
+  ejsDataPath: path.resolve(__dirname, './readme.js'), // Default template ejs data file
+  // EJS options (see https://www.npmjs.com/package/ejs#options)
+  ejsOptions: {
+    async: true
+    /* your ejs options... */
+  }
+}

package/template/docs/readme/readme.js

@@ -0,0 +1,70 @@
+/**
+ * @hperchec/readme-generator Template EJS data example file
+ */
+
+const markdownTable = require('markdown-table') // ! v3 not compatible, use v2
+
+// Based on the package.json file, get some data and informations
+const pkg = require('../../package.json')
+const packageName = pkg.name
+const packageUrl = `https://www.npmjs.com/package/${packageName}`
+const dependencies = pkg.dependencies || {}
+const devDependencies = pkg.devDependencies || {}
+const peerDependencies = pkg.peerDependencies || {}
+const author = pkg.author
+const contributors = pkg.contributors || []
+const license = pkg.license || 'Unknown'
+const homepage = pkg.homepage
+const projectUrl = pkg.repository.url
+const issuesUrl = pkg.bugs.url
+
+// Output a markdown formatted table from a js object
+// Like:
+// |name|version|
+// |----|-------|
+// |    |       |
+function getMdDependencies (deps) {
+  return markdownTable([
+    [ 'name', 'version' ],
+    ...(Object.entries(deps))
+  ])
+}
+
+/**
+ * Return author link
+ * @param {Object} author
+ * @return {string}
+ */
+function getMdAuthor (author) {
+  return '[' + author.name + '](' + author.url + ')'
+}
+
+/**
+ * Return markdown list of persons
+ * @param {Array} contributors
+ * @return {String}
+ */
+function getMdContributors (contributors) {
+  let mdString = ''
+  contributors.forEach((person) => {
+    mdString += '- [' + person.name + '](' + person.url + ')\n'
+  })
+  return mdString
+}
+
+/**
+ * Export data for readme file templating
+ */
+module.exports = {
+  packageName,
+  packageUrl,
+  projectUrl,
+  homepage,
+  issuesUrl,
+  dependencies: getMdDependencies(dependencies),
+  devDependencies: getMdDependencies(devDependencies),
+  peerDependencies: getMdDependencies(peerDependencies),
+  author: getMdAuthor(author),
+  contributors: getMdContributors(contributors),
+  license
+}

package/template/docs/readme/template.md

@@ -0,0 +1,53 @@
+# Awesome project
+
+[![author](https://img.shields.io/static/v1?label=&message=Author:&color=black)]()
+[![herve-perchec](http://herve-perchec.com/badge.svg)](http://herve-perchec.com/)
+
+**Table of contents**:
+
+[[*TOC*]]
+
+## 🚀 Get started
+
+```sh
+# Let's go!
+```
+
+## 📙 Documentation
+
+Please check the [documentation](https://www.npmjs.com/package/@hperchec/juisy)
+
+## 🧱 Dependencies
+
+<details>
+<summary>Global</summary>
+
+<%%= dependencies %>
+
+</details>
+
+<details>
+<summary>Dev</summary>
+
+<%%= devDependencies %>
+
+</details>
+
+<details>
+<summary>Peer</summary>
+
+<%%= peerDependencies %>
+
+</details>
+
+## ✍ Author
+
+<%%= author %>
+
+## 📄 License
+
+<%%= license %>
+
+----
+
+Made with ❤ by <%%= author %>