Merge pull request #37 from sebastienrousseau/0.2.455

0.2.455

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,6 @@
+{
+	"$schema": "https://unpkg.com/@changesets/config@2.2.0/schema.json",
+	"access": "public",
+  "baseBranch": "master",
+  "changelog": ["@changesets/changelog-github", {"repo": "sebastienrousseau/dotfiles"}]
+}

.editorconfig

@@ -1,4 +1,4 @@
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 # Copyright (c) Sebastien Rousseau 2022. All rights reserved
 # License: MIT
 

.github/workflows/release.yml

@@ -43,27 +43,31 @@ jobs:
       - uses: pnpm/action-setup@v2.2.2
         with:
           version: 7
-          registry-url: "https://registry.npmjs.org"
-          scope: sebastienrousseau
 
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-
-      - name: Publish to NPM
-        run: pnpm publish --access public --tag latest
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        run: echo "::set-output name=pnpm_cache_dir::$(pnpm store path)"
 
-      - name: Set package registry
-        run: pnpm config set registry https://npm.pkg.github.com
+      - name: Setup pnpm cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
 
-      - name: Github package registry authentication
-        run: pnpm set //npm.pkg.github.com/:_authToken ${{ secrets.GITHUB_TOKEN }}
+      - name: Install dependencies
+        run: pnpm install
 
-      - name: Npm registry authentication
-        run: pnpm set //registry.npmjs.org/:_authToken ${{ secrets.NPM_TOKEN }}
 
-      - name: Publish the package to Github package registry
-        run: pnpm -r publish --access public
+      - name: PR or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: pnpm run version
+          publish: pnpm run publish
         env:
-          NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          # Note: we are using a different GITHUB_TOKEN due to the issues in this thread:
+          # https://github.com/changesets/action/issues/187
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,4 +1,4 @@
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 # Copyright (c) Sebastien Rousseau 2022. All rights reserved
 # License: MIT
 

.npmrc

@@ -1,4 +1,4 @@
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 # Copyright (c) Sebastien Rousseau 2022. All rights reserved
 # License: MIT
 registry=https://npm.pkg.github.com/sebastienrousseau

COPYRIGHT

@@ -1,5 +1,5 @@
 /*
-* 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+* 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 * Copyright (c) Sebastien Rousseau 2022. All rights reserved
 * License: MIT
 */

Makefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env make -f
 
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 # Copyright (c) Sebastien Rousseau 2022. All rights reserved
 # License: MIT
 
@@ -19,13 +19,13 @@ else
 	sh $(HOMEDIR)/bin/dotfiles.sh backup
 endif
 
-.PHONY: prepare
-prepare: # @HELP Prepare the dotfiles on your system.
-prepare: ## Prepare the dotfiles on your system.
+.PHONY: assemble
+assemble: # @HELP Assemble the dotfiles on your system.
+assemble: ## Prepare the dotfiles on your system.
 ifdef PNPM
-	pnpm run prepare
+	pnpm run assemble
 else
-	sh $(HOMEDIR)/bin/dotfiles prepare
+	sh $(HOMEDIR)/bin/dotfiles assemble
 endif
 
 .PHONY: copy

README.md

@@ -13,7 +13,7 @@
 • [Request Feature][issues]
 • [Contributing Guidelines][contributing]**
 
-## 👋 Welcome to Dotfiles (v0.2.454)
+## 👋 Welcome to Dotfiles (v0.2.455)
 
 ### Simply designed to fit your shell life
 
@@ -22,7 +22,7 @@ aimed at making your life easier by providing a set of scripts and configuration
 files with new ways to get things done.
 
 [![Getting Started][getting_started]][getting-started]
-[![Download Dotfiles v0.2.454][download_button]][download]
+[![Download Dotfiles v0.2.455][download_button]][download]
 
 Dotfiles aggregates a collection of standalone configuration files (dotfiles)
 combined into a `shell` directory that can be used to customize your development
@@ -101,7 +101,7 @@ The following programs must be installed on your system to install Dotfiles:
 
 ### 1️⃣ Download Dotfiles
 
-You can download the latest version (v0.2.454) with the following options:
+You can download the latest version (v0.2.455) with the following options:
 
 - [**Manual download**][releases] - **The easiest way to install Dotfiles.**
 - [**Install with PnPM**](https://www.npmjs.com/package/@sebastienrousseau/dotfiles)
@@ -119,7 +119,7 @@ You can download the latest version (v0.2.454) with the following options:
 Before installing Dotfiles, we strongly recommend that you back up your existing
 data. The Dotfiles installer will try to automatically backup any previous
 installation of known dotfiles into a backup directory
-`$HOME/.dotfiles/backup`.
+`$HOME/.dotfiles_backup`.
 
 The backup files are the following:
 
@@ -150,9 +150,7 @@ The backup files are the following:
 cacert.pem
 ```
 
-After installation, you will find the backup files in the `~/dotfiles_backup`
-directory. It is always a good idea to backup as there might be situations in which you
-could be required to restore your previous installation.
+It is always a good idea to backup as there might be situations in which you could be required to restore your previous installation.
 
 ### 3️⃣ Try it out and let us know what you think
 
@@ -170,7 +168,7 @@ The installer will check if you have PnPM installed to switch to the PnPM instal
 Switch to the `dist` directory and run:
 
 ```bash
-make prepare
+make assemble
 ```
 
 You can also just check the installer options available, by simply running:
@@ -187,7 +185,7 @@ dotfiles rapidly and very efficiently.
 Switch to the `dist` directory and run:
 
 ```bash
-pnpm run prepare
+pnpm run assemble
 ```
 
 ### Post installation
@@ -208,7 +206,7 @@ Please refer to the [documentation][docs] for more information.
 Dotfiles contains core elements that are used to configure your shell, and other components catered for your environment setup.
 
 Within the download you'll find all the Dotfiles source files grouped within the
-`shell` folder.
+`dist` folder.
 
 You'll see something like this:
 
@@ -415,7 +413,7 @@ bunch of awesome [contributors](https://github.com/sebastienrousseau/dotfiles/gr
 [contributing]: https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CONTRIBUTING.md
 [curl]: https://curl.se/
 [docs]: https://github.com/sebastienrousseau/dotfiles/docs
-[download]: https://github.com/sebastienrousseau/dotfiles/archive/refs/tags/v0.2.454.tar.gz
+[download]: https://github.com/sebastienrousseau/dotfiles/archive/refs/tags/v0.2.455.tar.gz
 [getting-started]: https://github.com/sebastienrousseau/dotfiles#getting-started
 [git]: https://git-scm.com/
 [github]: https://github.com/sebastienrousseau/dotfiles

bin/compile.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 # Copyright (c) Sebastien Rousseau 2022. All rights reserved
 # License: MIT
 

bin/copy.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 # Copyright (c) Sebastien Rousseau 2022. All rights reserved
 # License: MIT
 

bin/dotfiles.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.454) - https://dotfiles.io
+# 🅳🅾🆃🅵🅸🅻🅴🆂 (v0.2.455) - https://dotfiles.io
 # Copyright (c) Sebastien Rousseau 2022. All rights reserved
 # License: MIT
 
@@ -10,7 +10,7 @@ BIRed='\033[1;91m'                    # Red color.
 DOTFILESDIR="${HOME}/.dotfiles"       # Location of dotfiles.
 DOWNLOADDIR="${HOME}/Downloads"       # Download directory.
 NC='\033[0m'                          # Reset/No Color
-VERSION="0.2.454"                     # Dotfiles Version number.
+VERSION="0.2.455"                     # Dotfiles Version number.
 
 ## 🅱🅰🅲🅺🆄🅿 - Backup existing files.
 backup() {
@@ -78,8 +78,8 @@ unpack() {
   rm "${DOWNLOADDIR}/v${VERSION}.zip"
 }
 
-## 🅿🆁🅴🅿🅰🆁🅴 - Prepare the dotfiles on your system.
-prepare() {
+## 🅰🆂🆂🅴🅼🅱🅻🅴 - Assemble the dotfiles on your system.
+assemble() {
   echo "${BIRed}❭${NC} Preparing the dotfiles on your system."
   backup &&
   download &&
@@ -146,7 +146,7 @@ COMMANDS:
   clean     - Removes any previous setup directories
   copy      - Copy the new dotfiles files to your '${HOME}' directory
   download  - Download the latest Dotfiles (v${VERSION})
-  prepare   - Run the full installation process
+  assemble  - Run the full installation process
   unpack    - Unpack the Dotfiles
   help      - Show the help menu
 
@@ -174,9 +174,9 @@ elif [ "$1" = "download" ]; then
   download
 elif [ "$1" = "help" ]; then
   help
-elif [ "$1" = "prepare" ]; then
+elif [ "$1" = "assemble" ]; then
   echo "${BIRed}❭${NC} Installing ${BIGreen}Dotfiles v${VERSION}${NC}."
-  prepare
+  assemble
 elif [ "$1" = "unpack" ]; then
   echo "${BIRed}❭${NC} Unpacking ${BIGreen}Dotfiles v${VERSION}${NC}."
   unpack

docs/README.md

@@ -13,7 +13,7 @@
 • [Request Feature][issues]
 • [Contributing Guidelines][contributing]**
 
-## 👋 Welcome to Dotfiles (v0.2.454)
+## 👋 Welcome to Dotfiles (v0.2.455)
 
 ### Simply designed to fit your shell life
 
@@ -22,7 +22,7 @@ aimed at making your life easier by providing a set of scripts and configuration
 files with new ways to get things done.
 
 [![Getting Started][getting_started]][getting-started]
-[![Download Dotfiles v0.2.454][download_button]][download]
+[![Download Dotfiles v0.2.455][download_button]][download]
 
 Dotfiles aggregates a collection of standalone configuration files (dotfiles)
 combined into a `shell` directory that can be used to customize your development
@@ -101,7 +101,7 @@ The following programs must be installed on your system to install Dotfiles:
 
 ### 1️⃣ Download Dotfiles
 
-You can download the latest version (v0.2.454) with the following options:
+You can download the latest version (v0.2.455) with the following options:
 
 - [**Manual download**][releases] - **The easiest way to install Dotfiles.**
 - [**Install with PnPM**](https://www.npmjs.com/package/@sebastienrousseau/dotfiles)
@@ -119,7 +119,7 @@ You can download the latest version (v0.2.454) with the following options:
 Before installing Dotfiles, we strongly recommend that you back up your existing
 data. The Dotfiles installer will try to automatically backup any previous
 installation of known dotfiles into a backup directory
-`$HOME/.dotfiles/backup`.
+`$HOME/.dotfiles_backup`.
 
 The backup files are the following:
 
@@ -150,9 +150,7 @@ The backup files are the following:
 cacert.pem
 ```
 
-After installation, you will find the backup files in the `~/dotfiles_backup`
-directory. It is always a good idea to backup as there might be situations in which you
-could be required to restore your previous installation.
+It is always a good idea to backup as there might be situations in which you could be required to restore your previous installation.
 
 ### 3️⃣ Try it out and let us know what you think
 
@@ -170,7 +168,7 @@ The installer will check if you have PnPM installed to switch to the PnPM instal
 Switch to the `dist` directory and run:
 
 ```bash
-make prepare
+make assemble
 ```
 
 You can also just check the installer options available, by simply running:
@@ -187,7 +185,7 @@ dotfiles rapidly and very efficiently.
 Switch to the `dist` directory and run:
 
 ```bash
-pnpm run prepare
+pnpm run assemble
 ```
 
 ### Post installation
@@ -208,7 +206,7 @@ Please refer to the [documentation][docs] for more information.
 Dotfiles contains core elements that are used to configure your shell, and other components catered for your environment setup.
 
 Within the download you'll find all the Dotfiles source files grouped within the
-`shell` folder.
+`dist` folder.
 
 You'll see something like this:
 
@@ -415,7 +413,7 @@ bunch of awesome [contributors](https://github.com/sebastienrousseau/dotfiles/gr
 [contributing]: https://github.com/sebastienrousseau/dotfiles/blob/master/.github/CONTRIBUTING.md
 [curl]: https://curl.se/
 [docs]: https://github.com/sebastienrousseau/dotfiles/docs
-[download]: https://github.com/sebastienrousseau/dotfiles/archive/refs/tags/v0.2.454.tar.gz
+[download]: https://github.com/sebastienrousseau/dotfiles/archive/refs/tags/v0.2.455.tar.gz
 [getting-started]: https://github.com/sebastienrousseau/dotfiles#getting-started
 [git]: https://git-scm.com/
 [github]: https://github.com/sebastienrousseau/dotfiles

package.json

@@ -24,10 +24,12 @@
 	],
 	"description": "Dotfiles - A set of macOS / Linux and Windows configuration files - Simply designed to fit your shell life.",
 	"devDependencies": {
+		"@changesets/cli": "^2.25.0",
 		"@types/node": "^16.11.64",
 		"@types/shelljs":"0.8.11",
 		"filesizes": "^0.1.2",
 		"jsmin": "^1.0.1",
+		"nps": "^5.10.0",
 		"pnpm": "^7.13.2",
 		"rimraf": "^3.0.2",
 		"shelljs": "^0.8.5",
@@ -93,16 +95,19 @@
 		"cp:zshr": "cp ./shell/configurations/zsh/zshrc $HOME/.zshrc",
 		"clean": "rimraf \"dist/\" && tsc --build --clean",
 		"cl:tmp": "rimraf \"./dist/shell/**/*.tmp\"",
+		"assemble": "pnpm run backup && pnpm run directory && pnpm run copy",
 		"build": "pnpm run clean && tsc --build tsconfig.json && pnpm run compile",
+		"changeset": "changeset",
 		"compile": "chmod 755 \"./bin/compile.sh\" && ./bin/compile.sh",
 		"directory": "mkdir $HOME/.dotfiles",
 		"filesizes": "filesizes ./dist/ > ./dist/filesizes.txt",
 		"help": "chmod 755 \"./bin/dotfiles.sh\" && ./bin/dotfiles.sh",
 		"minify": "jsmin ./shell/index.js > dist/shell/index.js",
-		"prepare": "pnpm run backup && pnpm run directory && pnpm run copy",
+		"publish": "nps git:tag && pnpm changeset publish --no-git-tag",
 		"start": "node dist/shell/index.js",
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"test": "echo \"Error: no test specified\" && exit 1",
+		"version": "pnpm changeset version && pnpm run assemble --no-frozen-lockfile"
 	},
 	"types": "./dist/index.d.ts",
-	"version": "0.2.454"
+	"version": "0.2.455"
 }