pax_global_header00006660000000000000000000000064136213053040014507gustar00rootroot0000000000000052 comment=7892c8ae62c963934ed2a77b1dcfd0713c6bbf99 configstore-5.0.1/000077500000000000000000000000001362130530400140345ustar00rootroot00000000000000configstore-5.0.1/.editorconfig000066400000000000000000000002571362130530400165150ustar00rootroot00000000000000root = true [*] indent_style = tab end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [*.yml] indent_style = space indent_size = 2 configstore-5.0.1/.gitattributes000066400000000000000000000000231362130530400167220ustar00rootroot00000000000000* text=auto eol=lf configstore-5.0.1/.github/000077500000000000000000000000001362130530400153745ustar00rootroot00000000000000configstore-5.0.1/.github/funding.yml000066400000000000000000000000571362130530400175530ustar00rootroot00000000000000github: sindresorhus tidelift: npm/configstore configstore-5.0.1/.github/security.md000066400000000000000000000002631362130530400175660ustar00rootroot00000000000000# Security Policy To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. configstore-5.0.1/.gitignore000066400000000000000000000000271362130530400160230ustar00rootroot00000000000000node_modules yarn.lock configstore-5.0.1/.npmrc000066400000000000000000000000231362130530400151470ustar00rootroot00000000000000package-lock=false configstore-5.0.1/.travis.yml000066400000000000000000000000541362130530400161440ustar00rootroot00000000000000language: node_js node_js: - '10' - '8' configstore-5.0.1/index.js000066400000000000000000000046341362130530400155100ustar00rootroot00000000000000'use strict'; const path = require('path'); const os = require('os'); const fs = require('graceful-fs'); const makeDir = require('make-dir'); const xdgBasedir = require('xdg-basedir'); const writeFileAtomic = require('write-file-atomic'); const dotProp = require('dot-prop'); const uniqueString = require('unique-string'); const configDirectory = xdgBasedir.config || path.join(os.tmpdir(), uniqueString()); const permissionError = 'You don\'t have access to this file.'; const makeDirOptions = {mode: 0o0700}; const writeFileOptions = {mode: 0o0600}; class Configstore { constructor(id, defaults, options = {}) { const pathPrefix = options.globalConfigPath ? path.join(id, 'config.json') : path.join('configstore', `${id}.json`); this.path = options.configPath || path.join(configDirectory, pathPrefix); if (defaults) { this.all = { ...defaults, ...this.all }; } } get all() { try { return JSON.parse(fs.readFileSync(this.path, 'utf8')); } catch (error) { // Create directory if it doesn't exist if (error.code === 'ENOENT') { return {}; } // Improve the message of permission errors if (error.code === 'EACCES') { error.message = `${error.message}\n${permissionError}\n`; } // Empty the file if it encounters invalid JSON if (error.name === 'SyntaxError') { writeFileAtomic.sync(this.path, '', writeFileOptions); return {}; } throw error; } } set all(value) { try { // Make sure the folder exists as it could have been deleted in the meantime makeDir.sync(path.dirname(this.path), makeDirOptions); writeFileAtomic.sync(this.path, JSON.stringify(value, undefined, '\t'), writeFileOptions); } catch (error) { // Improve the message of permission errors if (error.code === 'EACCES') { error.message = `${error.message}\n${permissionError}\n`; } throw error; } } get size() { return Object.keys(this.all || {}).length; } get(key) { return dotProp.get(this.all, key); } set(key, value) { const config = this.all; if (arguments.length === 1) { for (const k of Object.keys(key)) { dotProp.set(config, k, key[k]); } } else { dotProp.set(config, key, value); } this.all = config; } has(key) { return dotProp.has(this.all, key); } delete(key) { const config = this.all; dotProp.delete(config, key); this.all = config; } clear() { this.all = {}; } } module.exports = Configstore; configstore-5.0.1/license000066400000000000000000000024311362130530400154010ustar00rootroot00000000000000BSD 2-Clause License Copyright (c) Google All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. configstore-5.0.1/package.json000066400000000000000000000014741362130530400163300ustar00rootroot00000000000000{ "name": "configstore", "version": "5.0.1", "description": "Easily load and save config without having to think about where and how", "license": "BSD-2-Clause", "repository": "yeoman/configstore", "author": { "name": "Sindre Sorhus", "email": "sindresorhus@gmail.com", "url": "sindresorhus.com" }, "engines": { "node": ">=8" }, "scripts": { "test": "xo && ava" }, "files": [ "index.js" ], "keywords": [ "config", "store", "storage", "configuration", "settings", "preferences", "json", "data", "persist", "persistent", "save" ], "dependencies": { "dot-prop": "^5.2.0", "graceful-fs": "^4.1.2", "make-dir": "^3.0.0", "unique-string": "^2.0.0", "write-file-atomic": "^3.0.0", "xdg-basedir": "^4.0.0" }, "devDependencies": { "ava": "^2.1.0", "xo": "^0.24.0" } } configstore-5.0.1/readme.md000066400000000000000000000057151362130530400156230ustar00rootroot00000000000000# configstore [![Build Status](https://travis-ci.org/yeoman/configstore.svg?branch=master)](https://travis-ci.org/yeoman/configstore) > Easily load and persist config without having to think about where and how The config is stored in a JSON file located in `$XDG_CONFIG_HOME` or `~/.config`.
Example: `~/.config/configstore/some-id.json` *If you need this for Electron, check out [`electron-store`](https://github.com/sindresorhus/electron-store) instead.*
*And check out [`conf`](https://github.com/sindresorhus/conf) for an updated approach to this concept.* ## Install ``` $ npm install configstore ``` ## Usage ```js const Configstore = require('configstore'); const packageJson = require('./package.json'); // Create a Configstore instance const config = new Configstore(packageJson.name, {foo: 'bar'}); console.log(config.get('foo')); //=> 'bar' config.set('awesome', true); console.log(config.get('awesome')); //=> true // Use dot-notation to access nested properties config.set('bar.baz', true); console.log(config.get('bar')); //=> {baz: true} config.delete('awesome'); console.log(config.get('awesome')); //=> undefined ``` ## API ### Configstore(packageName, defaults?, options?) Returns a new instance. #### packageName Type: `string` Name of your package. #### defaults Type: `object` Default config. #### options Type: `object` ##### globalConfigPath Type: `boolean`
Default: `false` Store the config at `$CONFIG/package-name/config.json` instead of the default `$CONFIG/configstore/package-name.json`. This is not recommended as you might end up conflicting with other tools, rendering the "without having to think" idea moot. ##### configPath Type: `string`
Default: Automatic **Please don't use this option unless absolutely necessary and you know what you're doing.** Set the path of the config file. Overrides the `packageName` and `globalConfigPath` options. ### Instance You can use [dot-notation](https://github.com/sindresorhus/dot-prop) in a `key` to access nested properties. ### .set(key, value) Set an item. ### .set(object) Set multiple items at once. ### .get(key) Get an item. ### .has(key) Check if an item exists. ### .delete(key) Delete an item. ### .clear() Delete all items. ### .size Get the item count. ### .path Get the path to the config file. Can be used to show the user where the config file is located or even better open it for them. ### .all Get all the config as an object or replace the current config with an object: ```js config.all = { hello: 'world' }; ``` ---
Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
configstore-5.0.1/test.js000066400000000000000000000065151362130530400153600ustar00rootroot00000000000000import fs from 'fs'; import path from 'path'; import os from 'os'; import {serial as test} from 'ava'; import Configstore from '.'; const configstorePath = new Configstore('configstore-test').path; const cleanUpFile = () => { if (fs.existsSync(configstorePath)) { fs.unlinkSync(configstorePath); } }; test.beforeEach(t => { cleanUpFile(); t.context.config = new Configstore('configstore-test'); }); test('.set() and .get()', t => { const {config} = t.context; config.set('foo', 'bar'); config.set('baz.boo', true); t.is(config.get('foo'), 'bar'); t.is(config.get('baz.boo'), true); }); test('.set() with object and .get()', t => { const {config} = t.context; config.set({ foo1: 'bar1', foo2: 'bar2', baz: { boo: 'foo', foo: { bar: 'baz' } } }); t.is(config.get('foo1'), 'bar1'); t.is(config.get('foo2'), 'bar2'); t.deepEqual(config.get('baz'), { boo: 'foo', foo: { bar: 'baz' } }); t.is(config.get('baz.boo'), 'foo'); t.deepEqual(config.get('baz.foo'), {bar: 'baz'}); t.is(config.get('baz.foo.bar'), 'baz'); }); test('.has()', t => { const {config} = t.context; config.set('foo', '🦄'); config.set('baz.boo', '🦄'); t.true(config.has('foo')); t.true(config.has('baz.boo')); t.false(config.has('missing')); }); test('.delete()', t => { const {config} = t.context; config.set('foo', 'bar'); config.set('baz.boo', true); config.set('baz.foo.bar', 'baz'); config.delete('foo'); t.not(config.get('foo'), 'bar'); config.delete('baz.boo'); t.not(config.get('baz.boo'), true); config.delete('baz.foo'); t.not(config.get('baz.foo'), {bar: 'baz'}); config.set('foo.bar.baz', {awesome: 'icecream'}); config.set('foo.bar.zoo', {awesome: 'redpanda'}); config.delete('foo.bar.baz'); t.is(config.get('foo.bar.zoo.awesome'), 'redpanda'); }); test('.clear()', t => { const {config} = t.context; config.set('foo', 'bar'); config.set('foo1', 'bar1'); config.set('baz.boo', true); config.clear(); t.is(config.size, 0); }); test('.all', t => { const {config} = t.context; config.set('foo', 'bar'); config.set('baz.boo', true); t.is(config.all.foo, 'bar'); t.deepEqual(config.all.baz, {boo: true}); }); test('.size', t => { const {config} = t.context; config.set('foo', 'bar'); t.is(config.size, 1); }); test('.path', t => { const {config} = t.context; config.set('foo', 'bar'); t.true(fs.existsSync(config.path)); }); test('use default value', t => { const config = new Configstore('configstore-test', {foo: 'bar'}); t.is(config.get('foo'), 'bar'); }); test('support `globalConfigPath` option', t => { const config = new Configstore('configstore-test', {}, {globalConfigPath: true}); t.regex(config.path, /configstore-test(\/|\\)config.json$/); }); test('support `configPath` option', t => { const customPath = path.join(os.tmpdir(), 'configstore-custom-path', 'foo.json'); const config = new Configstore('ignored-namespace', {}, { globalConfigPath: true, configPath: customPath }); t.regex(config.path, /configstore-custom-path(\/|\\)foo.json$/); }); test('ensure `.all` is always an object', t => { cleanUpFile(); t.notThrows(() => { t.context.config.get('foo'); }); }); test('the store is NOT created until write', t => { cleanUpFile(); const config = new Configstore('configstore-test'); t.false(fs.existsSync(config.path)); config.set('foo', 'bar'); t.true(fs.existsSync(config.path)); });