
Security News
NIST Under Federal Audit for NVD Processing Backlog and Delays
As vulnerability data bottlenecks grow, the federal government is formally investigating NIST’s handling of the National Vulnerability Database.
@nteract/mythic-configuration
Advanced tools
This package implements a configuration system.
$ yarn add @nteract/mythic-configuration
$ npm install --save @nteract/mythic-configuration
Initialize the package by including the configuration
package. Per default it will save the configuration in memory.
If you would like to use a config file, you can dispatch a setConfigFile
action:
import { configuration } from "@nteract/mythic-configuration";
import { makeConfigureStore } from "@nteract/myths";
export const configureStore = makeConfigureStore({
packages: [configuration],
});
store.dispatch(setConfigFile("/etc/app.conf"));
The package will use that file to save any configuration options. The file is also watched and loaded when it changes.
After this initialisation, you can then work with configuration options:
export const {
selector: tabSize,
action: setTabSize,
} = defineConfigOption({
label: "Tab Size",
key: "codeMirror.tabSize",
values: [
{label: "2 Spaces", value: 2},
{label: "3 Spaces", value: 3},
{label: "4 Spaces", value: 4},
],
defaultValue: 4,
});
const currentValue = tabSize(store.getState());
store.dispatch(setTabSize(2));
To get an object from all config options with a common prefix, use createConfigCollection
:
const codeMirrorConfig = createConfigCollection({
key: "codeMirror",
});
Now codeMirrorConfig()
will give you e.g. with above option {tabSize: 4}
, with default values properly handled.
You can also get all options:
import { allConfigOptions } from "@nteract/mythic-configuration";
const options = allConfigOptions();
const optionsWithCurrentValues = allConfigOptions(store.getState());
In case you want to change the key of a config option, you can deprecate the old key:
createDeprecatedConfigOption({
key: "cursorBlinkRate",
changeTo: (value: number) => ({
"codeMirror.cursorBlinkRate": value,
}),
});
This will change the old key to the new key, unless the new key already has a value.
import { RootState } from "@nteract/myths";
import { ConfigurationState, setConfigAtKey } from "@nteract/mythic-configuration";
export interface ConfigurationOptionDefinition<TYPE = any> {
label: string;
key: string;
defaultValue: TYPE;
valuesFrom?: string;
values?: Array<{
label: string;
value: TYPE;
}>;
}
export interface ConfigurationOption<TYPE = any>
extends ConfigurationOptionDefinition<TYPE> {
value?: TYPE;
selector: (state: HasPrivateConfigurationState) => TYPE;
action: (value: TYPE) => typeof setConfigAtKey.action;
}
export type HasPrivateConfigurationState =
RootState<"configuration", ConfigurationState>;
If you experience an issue while using this package or have a feature request, please file an issue on the issue board and add the pkg:mythic-configuration
label.
FAQs
A configuration system based on the myths redux framework
The npm package @nteract/mythic-configuration receives a total of 6,174 weekly downloads. As such, @nteract/mythic-configuration popularity was classified as popular.
We found that @nteract/mythic-configuration demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 18 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As vulnerability data bottlenecks grow, the federal government is formally investigating NIST’s handling of the National Vulnerability Database.
Research
Security News
Socket’s Threat Research Team has uncovered 60 npm packages using post-install scripts to silently exfiltrate hostnames, IP addresses, DNS servers, and user directories to a Discord-controlled endpoint.
Security News
TypeScript Native Previews offers a 10x faster Go-based compiler, now available on npm for public testing with early editor and language support.