Add support for XDG_STATE_HOME (#6)

sindresorhus · Aug 5, 2021 · 2bbd2ce · 2bbd2ce
1 parent 3fc64a8
commit 2bbd2ce
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 3 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -24,6 +24,19 @@ console.log(xdgConfig);
 */
 export const xdgConfig: string | undefined;
 
+/**
+Directory for user-specific state files.
+
+@example
+```
+import {xdgState} from 'xdg-basedir';
+
+console.log(xdgState);
+//=> '/home/sindresorhus/.local/state'
+```
+*/
+export const xdgState: string | undefined;
+
 /**
 Directory for user-specific non-essential data files.
 

diff --git a/index.js b/index.js
@@ -10,6 +10,9 @@ export const xdgData = env.XDG_DATA_HOME ||
 export const xdgConfig = env.XDG_CONFIG_HOME ||
 	(homeDirectory ? path.join(homeDirectory, '.config') : undefined);
 
+export const xdgState = env.XDG_STATE_HOME ||
+	(homeDirectory ? path.join(homeDirectory, '.local', 'state') : undefined);
+
 export const xdgCache = env.XDG_CACHE_HOME || (homeDirectory ? path.join(homeDirectory, '.cache') : undefined);
 
 export const xdgRuntime = env.XDG_RUNTIME_DIR || undefined;

diff --git a/index.test-d.ts b/index.test-d.ts
@@ -1,10 +1,12 @@
 import {expectType, expectError} from 'tsd';
-import {xdgData, xdgConfig, xdgCache, xdgRuntime, xdgConfigDirectories, xdgDataDirectories} from './index.js';
+import {xdgData, xdgConfig, xdgState, xdgCache, xdgRuntime, xdgConfigDirectories, xdgDataDirectories} from './index.js';
 
 expectType<string | undefined>(xdgData);
 expectError<string>(xdgData);
-expectType<string | undefined>(xdgCache);
-expectError<string>(xdgCache);
+expectType<string | undefined>(xdgConfig);
+expectError<string>(xdgConfig);
+expectType<string | undefined>(xdgState);
+expectError<string>(xdgState);
 expectType<string | undefined>(xdgCache);
 expectError<string>(xdgCache);
 expectType<string | undefined>(xdgRuntime);

diff --git a/readme.md b/readme.md
@@ -37,6 +37,10 @@ Directory for user-specific data files.
 
 Directory for user-specific configuration files.
 
+### xdgState
+
+Directory for user-specific state files.
+
 ### xdgCache
 
 Directory for user-specific non-essential data files.

diff --git a/test.js b/test.js
@@ -19,6 +19,12 @@ test('x', t => {
 // 	t.is(xdgConfig, 'config');
 // });
 //
+// test('xdgState', t => {
+// 	process.env.XDG_CONFIG_HOME = 'state';
+// 	const {xdgState} = importFresh('.');
+// 	t.is(xdgState, 'state');
+// });
+//
 // test('xdgCache', t => {
 // 	process.env.XDG_CACHE_HOME = 'cache';
 // 	const {xdgCache} = importFresh('.');