happy 0.13.3 → 0.13.4

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/package.json

@@ -1,9 +1,11 @@
 {
   "name": "happy",
-  "version": "0.13.3",
+  "version": "0.13.4",
   "description": "Happy simplifies your day-to-day git workflow",
   "author": "Francisco Presencia <public@francisco.io> (https://francisco.io/)",
-  "funding": "https://www.paypal.me/franciscopresencia/19",
+  "funding": {
+    "url": "https://www.paypal.me/franciscopresencia/19"
+  },
   "license": "MIT",
   "scripts": {},
   "homepage": "https://github.com/franciscop/happy",

package/src/save.js

@@ -9,9 +9,10 @@ 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()}`;