Merge pull request #953 from 3YOURMIND/have-tarball-support

chore(build): add support to export packages as tarballs

.gitignore

@@ -5,6 +5,7 @@ node_modules/
 packages/kotti-ui/report.*.html
 packages/yoco/fonts/
 *.log
+packages/*/package.tar.gz
 
 # vite config gets transpiled in-place for a short moment
 vite.config.ts.timestamp*

README.md

@@ -219,6 +219,31 @@ In case this does not work as expected, you want to check out the [publish scrip
 yarn run build
 ```
 
+## Debugging
+
+### Creating tarballs
+
+For all packages that are published you can also create a tarball by running
+
+```bash
+# Create tarballs for all relevant packages
+yarn run tarball
+
+# Create tarball for a specific package
+yarn run tarball --filter @3yourmind/yoco
+
+# Can be combined with other commands
+yarn run build tarball
+
+# How the created tarballs can be installed in another project (yarn@1)
+yarn cache clean && yarn remove @3yourmind/yoco && yarn add ../path/to/kotti/packages/yoco/package.tar.gz
+```
+
+See more:
+
+- https://docs.npmjs.com/cli/v6/commands/npm-pack
+- https://classic.yarnpkg.com/en/docs/cli/add
+
 ## Internals
 
 ### Important Folders

package.json

@@ -121,6 +121,7 @@
 		"fix:stylelint": "turbo run fix:stylelint",
 		"prepare": "husky install",
 		"prepublishOnly": "turbo run check build",
+		"tarball": "turbo run tarball",
 		"test": "turbo run test",
 		"watch": "nodemon -e css,js,json,scss,ts,vue --watch packages/vue-use-tippy/source --watch packages/yoco/source --exec \"turbo run watch\""
 	},

packages/documentation/turbo.json

@@ -2,6 +2,23 @@
 	"$schema": "https://turbo.build/schema.v1.json",
 	"extends": ["//"],
 	"pipeline": {
+		"build": {
+			"inputs": [
+				"assets/**",
+				"components/**",
+				"data/**",
+				"hooks/**",
+				"layouts/**",
+				"pages/**",
+				"plugins/**",
+				"styles/**",
+				"utilities/**",
+				"nuxt.config.ts",
+				"package.json",
+				"shims-*.d.ts",
+				"tsconfig.json"
+			]
+		},
 		"check:publint": {
 			"dependsOn": []
 		},

packages/eslint-config/package.json

@@ -57,7 +57,8 @@
 		"check:publint": "publint",
 		"fix:eslint": "yarn run check:eslint --fix",
 		"fix:prettier": "yarn run check:prettier --write",
-		"publish-package": "yarn publish --no-git-tag-version --verbose --non-interactive --access public"
+		"publish-package": "yarn publish --no-git-tag-version --verbose --non-interactive --access public",
+		"tarball": "npm pack && mv *.tgz package.tar.gz"
 	},
 	"type": "module",
 	"types": "./dist/mjs/index.d.ts",

packages/kotti-ui/package.json

@@ -86,6 +86,7 @@
 		"fix:prettier": "yarn run check:prettier --write",
 		"fix:stylelint": "yarn run check:stylelint --fix",
 		"publish-package": "yarn publish --no-git-tag-version --verbose --non-interactive --access public",
+		"tarball": "npm pack && mv *.tgz package.tar.gz",
 		"test": "vitest --run --typecheck",
 		"watch": "vite build --watch"
 	},

packages/vue-use-tippy/package.json

@@ -56,7 +56,8 @@
 		"check:publint": "publint",
 		"fix:eslint": "yarn run check:eslint --fix",
 		"fix:prettier": "yarn run check:prettier --write",
-		"publish-package": "yarn publish --no-git-tag-version --verbose --non-interactive --access public"
+		"publish-package": "yarn publish --no-git-tag-version --verbose --non-interactive --access public",
+		"tarball": "npm pack && mv *.tgz package.tar.gz"
 	},
 	"type": "module",
 	"types": "./dist/mjs/index.d.ts",

packages/yoco/package.json

@@ -63,7 +63,8 @@
 		"check:stylelint": "stylelint style.css",
 		"fix:eslint": "yarn run check:eslint --fix",
 		"fix:prettier": "yarn run check:prettier --write",
-		"publish-package": "yarn publish --no-git-tag-version --verbose --non-interactive --access public"
+		"publish-package": "yarn publish --no-git-tag-version --verbose --non-interactive --access public",
+		"tarball": "npm pack && mv *.tgz package.tar.gz"
 	},
 	"style": "./style.css",
 	"type": "module",

packages/yoco/turbo.json

@@ -4,8 +4,10 @@
 	"pipeline": {
 		"build": {
 			"inputs": ["scripts/**", "source/**", "svg/**", "tsconfig.*"],
-			"outputMode": "new-only",
 			"outputs": ["dist/**", "fonts/**"]
+		},
+		"tarball": {
+			"inputs": ["fonts/**", "dist/**", "svg/**", "style.css"]
 		}
 	}
 }

turbo.json

@@ -58,6 +58,12 @@
 			"cache": false,
 			"dependsOn": ["build", "check", "test"]
 		},
+		"tarball": {
+			"dependsOn": ["build"],
+			"inputs": ["dist/**", "package.json"],
+			"outputMode": "new-only",
+			"outputs": ["./package.tar.gz"]
+		},
 		"test": {},
 		"watch": {
 			"cache": false,