platformdirs - npm Package Compare versions

Comparing version 4.3.7 to 4.3.8-rc1

package.json

 {
 	"name": "platformdirs",
-	"version": "4.3.7",
+	"version": "4.3.8-rc1",
 	"description": "📂 Unified interface to get platform-specific directories",
@@ -16,3 +16,3 @@ "keywords": [
 	],
-	"homepage": "https://jsdocs.io/package/platformdirs",
+	"homepage": "https://tsdocs.dev/docs/platformdirs",
 	"repository": {
@@ -26,22 +26,18 @@ "type": "git",
 	"exports": {
-		".": "./dist/index.js",
-		"./android": "./dist/android.js",
-		"./api": "./dist/api.js",
-		"./macos": "./dist/macos.js",
-		"./unix": "./dist/unix.js",
-		"./version": "./dist/version.js"
+		".": "./src/index.js",
+		"./android": "./src/android.js",
+		"./api": "./src/api.js",
+		"./macos": "./src/macos.js",
+		"./unix": "./src/unix.js",
+		"./version": "./src/version.js"
 	},
 	"bin": {
-		"platformdirs": "dist/main.js"
+		"platformdirs": "src/main.js"
 	},
-	"files": [
-		"dist"
-	],
+	"files": ["src"],
 	"scripts": {
-		"build": "tsc --noCheck",
 		"format": "biome format --write .",
 		"lint": "biome check --write . && tsc --noEmit",
-		"run": "tsx src/main.ts",
-		"test": "tsx --test",
-		"prepack": "npm run build"
+		"run": "node src/main.js",
+		"test": "node --test"
 	},
@@ -51,5 +47,6 @@ "devDependencies": {
 		"@types/node": "^22.9.0",
+		"@types/which": "^3.0.4",
 		"execa": "^9.5.1",
-		"tsx": "^4.19.2",
-		"typescript": "^5.6.3"
+		"typescript": "^5.6.3",
+		"which": "^5.0.0"
 	},
@@ -56,0 +53,0 @@ "engines": {

README.md

@@ -7,4 +7,2 @@ # `platformdirs` for JavaScript
 
-<div><sub><i>Running on Linux</i></sub></div>
-
 ```js
@@ -26,3 +24,3 @@ const dirs = new PlatformDirs("awesome-app", "octocat", "1.2")
 <p align=center>
-    <a href="https://jsdocs.io/package/platformdirs">Documentation</a>
+    <a href="https://tsdocs.dev/docs/platformdirs">Documentation</a>
     | <a href="https://pypi.org/project/platformdirs/">Original <code>platformdirs</code> project</a>
@@ -38,2 +36,5 @@ </p>
 ![npm](https://img.shields.io/static/v1?style=for-the-badge&message=npm&color=CB3837&logo=npm&logoColor=FFFFFF&label=)
+![pnpm](https://img.shields.io/static/v1?style=for-the-badge&message=pnpm&color=222222&logo=pnpm&logoColor=F69220&label=)
+![Bun](https://img.shields.io/static/v1?style=for-the-badge&message=Bun&color=000000&logo=Bun&logoColor=FFFFFF&label=)
+![Deno](https://img.shields.io/static/v1?style=for-the-badge&message=Deno&color=222222&logo=Deno&logoColor=70FFAF&label=)
 
@@ -46,2 +47,4 @@ You can install this package from [the npm registry](https://www.npmjs.com/) using npm, Yarn, pnpm, Bun, Deno, etc.
 
+This package works with Node.js, Deno, and Bun. It is not intended to be used in the browser.
+
 ## Usage
@@ -71,3 +74,3 @@
 
-📚 For more information check out [the documentation](https://jsdocs.io/package/platformdirs)
+📚 For more information check out [the documentation](https://tsdocs.dev/docs/platformdirs)
 
@@ -83,3 +86,70 @@ You can quickly dump all the directories for the current environment by running the included `platformdirs` CLI command. This is helpful for quickly determining what `dirs.userConfigDir` and friends return.
 ```
-TODO
+-- platformdirs 4.3.7 --
+-- app dirs (with optional 'version')
+user_data_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0
+user_config_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0
+user_cache_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\Cache\1.0
+user_state_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0
+user_log_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\1.0\Logs
+user_documents_dir: C:\Users\me\Documents
+user_downloads_dir: C:\Users\me\Downloads
+user_pictures_dir: C:\Users\me\Pictures
+user_videos_dir: C:\Users\me\Videos
+user_music_dir: C:\Users\me\Music
+user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp\1.0
+site_data_dir: C:\ProgramData\MyCompany\MyApp\1.0
+site_config_dir: C:\ProgramData\MyCompany\MyApp\1.0
+site_cache_dir: C:\ProgramData\MyCompany\MyApp\Cache\1.0
+site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp\1.0
+
+-- app dirs (without optional 'version')
+user_data_dir: C:\Users\me\AppData\Local\MyCompany\MyApp
+user_config_dir: C:\Users\me\AppData\Local\MyCompany\MyApp
+user_cache_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\Cache
+user_state_dir: C:\Users\me\AppData\Local\MyCompany\MyApp
+user_log_dir: C:\Users\me\AppData\Local\MyCompany\MyApp\Logs
+user_documents_dir: C:\Users\me\Documents
+user_downloads_dir: C:\Users\me\Downloads
+user_pictures_dir: C:\Users\me\Pictures
+user_videos_dir: C:\Users\me\Videos
+user_music_dir: C:\Users\me\Music
+user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp
+site_data_dir: C:\ProgramData\MyCompany\MyApp
+site_config_dir: C:\ProgramData\MyCompany\MyApp
+site_cache_dir: C:\ProgramData\MyCompany\MyApp\Cache
+site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyCompany\MyApp
+
+-- app dirs (without optional 'appauthor')
+user_data_dir: C:\Users\me\AppData\Local\MyApp\MyApp
+user_config_dir: C:\Users\me\AppData\Local\MyApp\MyApp
+user_cache_dir: C:\Users\me\AppData\Local\MyApp\MyApp\Cache
+user_state_dir: C:\Users\me\AppData\Local\MyApp\MyApp
+user_log_dir: C:\Users\me\AppData\Local\MyApp\MyApp\Logs
+user_documents_dir: C:\Users\me\Documents
+user_downloads_dir: C:\Users\me\Downloads
+user_pictures_dir: C:\Users\me\Pictures
+user_videos_dir: C:\Users\me\Videos
+user_music_dir: C:\Users\me\Music
+user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp\MyApp
+site_data_dir: C:\ProgramData\MyApp\MyApp
+site_config_dir: C:\ProgramData\MyApp\MyApp
+site_cache_dir: C:\ProgramData\MyApp\MyApp\Cache
+site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp\MyApp
+
+-- app dirs (with disabled 'appauthor')
+user_data_dir: C:\Users\me\AppData\Local\MyApp
+user_config_dir: C:\Users\me\AppData\Local\MyApp
+user_cache_dir: C:\Users\me\AppData\Local\MyApp\Cache
+user_state_dir: C:\Users\me\AppData\Local\MyApp
+user_log_dir: C:\Users\me\AppData\Local\MyApp\Logs
+user_documents_dir: C:\Users\me\Documents
+user_downloads_dir: C:\Users\me\Downloads
+user_pictures_dir: C:\Users\me\Pictures
+user_videos_dir: C:\Users\me\Videos
+user_music_dir: C:\Users\me\Music
+user_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp
+site_data_dir: C:\ProgramData\MyApp
+site_config_dir: C:\ProgramData\MyApp
+site_cache_dir: C:\ProgramData\MyApp\Cache
+site_runtime_dir: C:\Users\me\AppData\Local\Temp\MyApp
 ```
@@ -178,2 +248,6 @@
 
-This project uses Node.js, TypeScript, and npm. Why Node.js instead of [Deno](https://deno.com/) & [JSR](https://jsr.io/)? Because it's not as popular (yet). I'd love to use Deno & JSR but nobody knows what they are. This project does use [Biome](https://biomejs.dev/) instead of the usual [Prettier](https://prettier.io/) & [ESLint](https://eslint.org/) combo. Why? Because ESLint bungled their v9 release and Biome offers a more cohesive linter & formatter solution.
+This project uses Node.js, npm, TypeScript, and [Biome](https://biomejs.dev/) instead of the usual [Prettier](https://prettier.io/) & [ESLint](https://eslint.org/) combo. Why? Because ESLint bungled their v9 release and Biome offers a more cohesive linter & formatter solution.
+
+For package releases make sure to always release a `-rc1` version first. If it's 100% OK then proceed to release it as normal. The goal is to keep the npm `platformdirs@X.Y.Z` package in sync with PyPI `platformdirs==X.Y.Z`.
+
+So far I have failed at this and now I'm two patch versions _ahead_ of the Python package. Oopsies.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

247

increased by42.77%

Worsened metrics

Total package byte prevSize

68682

decreased by-25.41%

Dev dependency count

6

increased by20%

Number of package files

12

decreased by-36.84%

Lines of code

2064

decreased by-10.03%

Number of low quality alerts

1

increased byInfinity%

No dependency changes