happy 0.13.0 → 0.13.4

package/.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: https://www.paypal.me/franciscopresencia/19

package/README.md

@@ -67,26 +67,122 @@ $ happy --help
 
 It makes sure your project is ready to deploy, and then deploy it. For this, these are the steps:
 
-- "Building project": run `npm run build` *if* the `"build"` script is found in your `package.json`.
-- "Linting": run `npm run lint` *if* the `"lint"` script is found in the project `package.json`.
-- "Testing project": run `npm test` *if* the `"test"` script is found in the project `package.json`.
-- "Saving changes": add all of the files with git, equivalent to `git add . && git commit -m "Saved on $TIME"`. Provide a message for a custom git message.
-- "Downloading latest": git pull
-- "Uploading changes": git push
-- "Publish to npm": _only_ if the `--publish` flag is passed, publish it to npm.
+- ["Building project"](#building-project): run `npm run build` *if* the `"build"` script is found in your `package.json`.
+- ["Linting"](#linting): run `npm run lint` *if* the `"lint"` script is found in the project `package.json`.
+- ["Testing project"](#testing-project): run `npm test` *if* the `"test"` script is found in the project `package.json`.
+- ["Saving changes"](#saving-changes): add all of the files with git, equivalent to `git add . && git commit -m "Saved on $TIME"`. Provide a message for a custom git message.
+- ["Downloading latest"](#downloading-latest): git pull
+- ["Uploading changes"](#uploading-changes): git push
+- ["Publish to npm"](#publish-to-npm): _only_ if the `--publish` flag is passed, publish it to npm.
 
 
-Run it with a string to use it as a commit string:
+
+### Building project
+
+Run the `npm run build` script *if* this script is found in your `package.json` configuration. Example:
+
+```json
+{
+  "scripts": {
+    "build": "rollup -c"
+  }
+}
+```
+
+This step will be **skipped** if:
+- The script `"build"` is not found in the project `package.json`.
+- The flag `--now` was passed.
+
+
+
+### Linting
+
+Run the `npm run lint` script *if* this script is found in your `package.json` configuration. Example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint"
+  }
+}
+```
+
+This step will be **skipped** if:
+- The script `"lint"` is not found in the project `package.json`.
+- The flag `--now` was passed.
+
+
+
+### Testing project
+
+Run the `npm test` script *if* this script is found in your `package.json` configuration. Example:
+
+```json
+{
+  "scripts": {
+    "test": "jest"
+  }
+}
+```
+
+The test script will also set the environment variable CI=true to avoid [some common issues](https://stackoverflow.com/a/56917151/938236).
+
+This step will be **skipped** if:
+- The script `"test"` is not found in the project `package.json`.
+- The flag `--now` was passed.
+
+
+
+### Saving Changes
+
+This is the equivalent of _adding_ and _commiting_ the changed files to Git. The message for the commit is the string that you pass:
 
 ```bash
 happy "Added that new cool feature"
 ```
 
-Add a `--now` to skip building, linting and testing. It _only_ runs these if they are found, so no need for `--now` if you don't have any of these npm scripts:
+When no string is provided, it will save the changes with a generic commit with the current timestamp like:
 
-```bash
-happy --now
 ```
+Saved on 2020-08-13T10:20:00Z
+```
+
+This step will be **skipped** if:
+- There are no changes to add or commit.
+- The changes were already commited.
+
+
+
+### Downloading latest
+
+Try to pull the latest changes from the remote repo to combine them locally. It will exit if there's a problem with the merge so that you can merge it manually.
+
+> This step might take longer than the others since it talks to your git server.
+
+This step will be **skipped** if:
+- There were no changes in the remote repo (you are up to date).
+
+This step will **throw an error** if:
+- The origin is not set.
+
+> TODO: ask/fix the origin if it's not set
+
+
+
+### Uploading changes
+
+Take all of your changes and upload them to the `origin` that is set in your project. This is specially useful when combined with e.g. Heroku, and you set heroku as the origin, since it will also deploy the full website.
+
+This step takes longer than the others since it's talking to your git server.
+
+This step will be **skipped** if:
+- There were no changes in the local repo.
+
+
+
+### Publish to npm
+
+> You need to have the library `np` installed for this, please do `npm i np -g`
 
 Add a `--publish VERSION` flag to publish the current package to npm with [np](https://github.com/sindresorhus/np#readme):
 
@@ -107,3 +203,5 @@ happy --major
 
 happy --publish 5.0.0
 ```
+
+

package/index.js

@@ -11,7 +11,7 @@ const {
   pull,
   push,
   save,
-  test
+  test,
 } = require("./src/index.js");
 
 const { flags, input } = meow(
@@ -48,22 +48,22 @@ const { flags, input } = meow(
     flags: {
       now: {
         type: "boolean",
-        alias: "n"
+        alias: "n",
       },
       publish: {
         type: "string",
-        alias: "p"
+        alias: "p",
       },
       patch: {
-        type: "boolean"
+        type: "boolean",
       },
       minor: {
-        type: "boolean"
+        type: "boolean",
       },
       major: {
-        type: "boolean"
-      }
-    }
+        type: "boolean",
+      },
+    },
   }
 );
 
@@ -86,8 +86,8 @@ if (flags.publish) {
   action.push(publish);
 }
 
-const tasks = new listr(action.map(task => task({ flags, input })));
+const tasks = new listr(action.map((task) => task({ flags, input })));
 
 analyze()
-  .then(ctx => tasks.run(ctx))
-  .catch(error => console.error(error));
+  .then((ctx) => tasks.run(ctx))
+  .catch((error) => console.error(error));

package/package.json

@@ -1,13 +1,16 @@
 {
   "name": "happy",
-  "version": "0.13.0",
+  "version": "0.13.4",
   "description": "Happy simplifies your day-to-day git workflow",
   "author": "Francisco Presencia <public@francisco.io> (https://francisco.io/)",
-  "main": "index.js",
-  "scripts": {},
-  "bin": {
-    "happy": "index.js"
+  "funding": {
+    "url": "https://www.paypal.me/franciscopresencia/19"
   },
+  "license": "MIT",
+  "scripts": {},
+  "homepage": "https://github.com/franciscop/happy",
+  "repository": "https://github.com:franciscop/happy.git",
+  "bugs": "https://github.com/franciscop/happy/issues",
   "keywords": [
     "happy",
     "command",
@@ -16,11 +19,13 @@
     "save",
     "deploy"
   ],
-  "homepage": "https://github.com/franciscop/happy",
-  "repository": "git@github.com:franciscop/happy.git",
-  "license": "MIT",
+  "bin": {
+    "happy": "index.js"
+  },
+  "main": "index.js",
   "dependencies": {
     "atocha": "^1.2.0",
+    "cross-env": "^7.0.2",
     "files": "^1.0.0",
     "listr": "^0.14.3",
     "meow": "^5.0.0"

package/src/analyze.js

@@ -2,7 +2,7 @@
 const cmd = require("atocha");
 const { exists, read } = require("files");
 
-module.exports = async ctx => {
+module.exports = async (ctx) => {
   if (!(await exists("package.json"))) return {};
   const pkg = await read("package.json");
   return { pkg: JSON.parse(pkg) };

package/src/build.js

@@ -4,11 +4,11 @@ const { stderrok } = require("./helpers");
 
 let test = "jest";
 
-module.exports = cli => ({
+module.exports = (cli) => ({
   title: "Building project",
-  skip: async ctx => {
+  skip: async (ctx) => {
     if (!ctx.pkg) return true;
     if (!ctx.pkg.scripts.build) return true;
   },
-  task: async ctx => cmd("npm run build").catch(stderrok)
+  task: async (ctx) => cmd("npm run build").catch(stderrok),
 });

package/src/helpers.js

@@ -1,5 +1,5 @@
 // Accept these errors
-exports.wtf = err => {
+exports.wtf = (err) => {
   if (/branch\s+master\s+-> FETCH_HEAD/.test(err.message)) return;
   if (/master -> master/.test(err.message)) return;
   if (/Everything up-to-date/.test(err.message)) return;
@@ -7,7 +7,7 @@ exports.wtf = err => {
 };
 
 // Only throw if the error is not 0
-exports.stderrok = error => {
+exports.stderrok = (error) => {
   // 0 or undefined should be ignored
   if (!error.code) return;
   throw error;

package/src/index.js

@@ -15,5 +15,5 @@ module.exports = {
   pull,
   push,
   save,
-  test
+  test,
 };

package/src/lint.js

@@ -2,18 +2,20 @@ const cmd = require("atocha");
 const { read } = require("files");
 const { stderrok } = require("./helpers");
 
-module.exports = cli => ({
+const ci = "export CI=true || set CI=true&&";
+
+module.exports = (cli) => ({
   title: "Linting",
-  skip: async ctx => {
+  skip: async (ctx) => {
     if (!ctx.pkg) return true;
     if (!ctx.pkg.scripts.lint && !ctx.pkg.scripts.linter) return true;
   },
-  task: async ctx => {
+  task: async (ctx) => {
     if (ctx.pkg.scripts.lint) {
-      return await cmd("npm run lint").catch(stderrok);
+      return await cmd(`${ci} npm run lint`).catch(stderrok);
     }
     if (ctx.pkg.scripts.linter) {
-      return await cmd("npm run linter").catch(stderrok);
+      return await cmd(`${ci} npm run linter`).catch(stderrok);
     }
-  }
+  },
 });

package/src/publish.js

@@ -1,9 +1,9 @@
 const cmd = require("atocha");
 const { read } = require("files");
 
-module.exports = cli => ({
+module.exports = (cli) => ({
   title: "Publish to npm",
-  skip: async ctx => {
+  skip: async (ctx) => {
     if (!cli.flags.publish) return true;
     // 5.0.0
     if (!/^\d+\.\d+\.\d+$/.test(await cmd(`np --version`))) {
@@ -11,7 +11,7 @@ module.exports = cli => ({
     }
     return false;
   },
-  task: async ctx => {
+  task: async (ctx) => {
     await cmd(`np ${cli.flags.publish} --yolo --no-release-draft`);
-  }
+  },
 });

package/src/pull.js

@@ -1,7 +1,7 @@
 const cmd = require("atocha");
 const { wtf } = require("./helpers");
 
-module.exports = cli => ({
+module.exports = (cli) => ({
   title: "Downloading latest",
   skip: async () => {
     const status = await cmd(`git status`);
@@ -10,5 +10,5 @@ module.exports = cli => ({
     const updated = /Your branch is up to date with/.test(status);
     if (updated) return true;
   },
-  task: async () => await cmd(`git pull origin master`).catch(wtf)
+  task: async () => await cmd(`git pull origin master`).catch(wtf),
 });

package/src/push.js

@@ -1,12 +1,12 @@
 const cmd = require("atocha");
 const { wtf } = require("./helpers");
 
-module.exports = cli => ({
+module.exports = (cli) => ({
   title: "Uploading changes",
   skip: async () => {
     const status = await cmd(`git status`);
     const hasCommited = /Your branch is ahead of/.test(status);
     if (!hasCommited) return true;
   },
-  task: async () => await cmd(`git push`).catch(wtf)
+  task: async () => await cmd(`git push`).catch(wtf),
 });

package/src/save.js

@@ -5,17 +5,18 @@ const { stderrok } = require("./helpers");
 // ISO 8601 without milliseconds (which is still ISO 8601)
 const time = () => new Date().toISOString().replace(/\.[0-9]{3}/, "");
 
-module.exports = cli => ({
+module.exports = (cli) => ({
   title: "Saving changes",
   skip: async () => {
     const status = await cmd(`git status`);
-    const hasEdited = /Changes not staged for commit/.test(status);
-    const hasUncommited = /Changes to be committed/.test(status);
-    if (!hasEdited && !hasUncommited) return true;
+    const hasAdded = /untracked files present/i.test(status);
+    const hasEdited = /Changes not staged for commit/i.test(status);
+    const hasUncommited = /Changes to be committed/i.test(status);
+    if (!hasAdded && !hasEdited && !hasUncommited) return true;
   },
   task: async () => {
     const message = cli.input[0] || `Saved on ${time()}`;
     await cmd(`git add . -A`).catch(stderrok);
     return await cmd(`git commit -m "${message}"`).catch(stderrok);
-  }
+  },
 });

package/src/test.js

@@ -2,11 +2,13 @@ const cmd = require("atocha");
 const { read } = require("files");
 const { stderrok } = require("./helpers");
 
-module.exports = cli => ({
+const ci = "export CI=true || set CI=true&&";
+
+module.exports = (cli) => ({
   title: "Testing project",
-  skip: async ctx => {
+  skip: async (ctx) => {
     if (!ctx.pkg) return true;
     if (!ctx.pkg.scripts.test) return true;
   },
-  task: async ctx => cmd("npm run test").catch(stderrok)
+  task: async (ctx) => cmd(`${ci} npm run test`).catch(stderrok),
 });