NodeSitecore Config

A shared configuration between @node-sitecore/cli and @node-sitecore/vue

Features

• Control over configuration values.
• Support multiple configuration files by environment (.nscrc (default), .development.nscrc, .test.nscrc, .production.nscrc).
• All value can be overridden by env or args variable (nconf)

Installation

$ npm install -g @node-sitecore/config

Usage

In node.js:

const config = require('@node-sitecore/config');

// getters
console.log(config.currentWebsite) // Custom
console.log(config.websiteRoot) // build/Website

// get()

console.log(config.get('bundles')) // Object {bundleName: "bundle", ...}

// or

console.log(config.get('bundles:bundleName') // bundle

// has()
console.log(config.has('bundle:bundleName')) // true


// set()
config.set('bundle:bundleName', "bundle-app");

// resolver
config.resolve('<rootDir>') // path/to/root
config.resolve('<instanceDir>') // path/to/root/build
config.resolve('<websiteDir>') // path/to/root/build/Website
config.resolve('<themesDir>') // path/to/root/build/Website/themes
config.resolve('<srcDir>') // path/to/root/src
config.resolve('<projectDir>') // path/to/root/src/Project
config.resolve('<featureDir>') // path/to/root/src/Feature
config.resolve('<foundationDir>') // path/to/root/src/Foundation
config.resolve('<currentDir>') // path/to/root/src/Project/Custom/code
config.resolve('<masterDir>') // path/to/root/src/Project/Common/code

// resolver + concat path
config.resolve('<masterDir>', 'Styles') // path/to/root/src/Project/Common/code/Styles

Configuration fields

Key	Default value	Tags	Description
currentWebsite	Common	Sitecore, Vuejs	Current code name of the Sitecore website (Can be the same as masterWebsite. It used for localisation process).
masterWebsite	Common	Sitecore, Vuejs	Master code name of the Sitecore website.
solutionName	Base	Sitecore	Solution name of the Visual Studio project.
siteUrl	http://base.dev.local	Sitecore	Site url use on your local machine. You change this value in a separated file like .dev.nsrc.
authConfigFilePath	path/to//Unicorn.UI.config	Auth config file path required by Unicorn task.
instanceRoot	http://base.dev.local	Sitecore	Path to the Sitecore instance directory.
srcRoot	./src	Sitecore	Source code directory.
websiteRoot	./website	Sitecore	Website directory used by Sitecore.
foundationRoot	./src/Foundation	Sitecore	Foundation level directory (Helix structure).
foundationScriptsRoot	./Core/code/Scripts	Sitecore	Scripts Foundation directory. Shortcut to the shared code.
featureRoot	./src/Feature	Sitecore	Feature level directory (Helix structure).
projectRoot	./src/Project	Sitecore	Project level directory (Helix structure).
sitecoreLibrariesRoot	./Website/bin	Sitecore	Sitecore libraries directory.
licensePath	./Data/license.xml	Sitecore	License path required by Sitecore.
buildConfiguration	Debug	MsBuild	MsBuild Configuration (Release or Debug).
buildToolsVersion	15.0	MsBuild	MsBuild .NET Tools-Version (1.0, 1.1, 2.0, 3.5, 4.0, 12.0, 14.0, 15.0, auto).
buildMaxCpuCount	0	MsBuild	Maximal CPU-Count to use. (-1: MSBuild Default, 0: Automatic selection, > 0: Concrete value).
buildVerbosity	minimal	MsBuild	Specify the amount of information to display in the build output (quiet, minimal, normal, detailed, diagnostic).
buildNodeReuse	false	MsBuild	MsBuild Specify whether to enable or disable the re-use of MSBuild nodes (true or false).
buildLogCommand	false	MsBuild	Logs the MsBuild command that will be executed.
excludeFilesFromDeployment	['packages.config']	MsBuild	Exclude files from the deployment on the Sitecore instance.
buildTargets	['Build']	MsBuild	Build targets options (Build, Clean, Rebuild).
buildPlatform	Any CPU	MsBuild	Build targets options (e.g. x86, x64, Any CPU).
buildProperties	{}	MsBuild	Additional build properties.
publishTargets	['Build']	MsBuild	Publish targets options (Build, Clean, Rebuild).
publishPlatform	AnyCpu	MsBuild	Publish platform (e.g. x86, x64, AnyCpu).
publishProperties	{...}	MsBuild	Additional publish properties.
bundles	{...}	Vuejs	Additional publish properties.

PublishProperties

Default value of publishProperties:

{
  "DeployOnBuild": "true",
  "DeployDefaultTarget": "WebPublish",
  "WebPublishMethod": "FileSystem",
  "DeleteExistingFiles": "false",
  "_FindDependencies": "false"
}

Bundles

Default value of bundles:

{
  "bundleName": "bundle",
  "polyfills": "polyfills",
  "styleguide": "styleguide"
}

Hierarchical configuration

Configuration management can get complicated very quickly for even trivial applications running in production. nconf addresses this problem by enabling you to setup a hierarchy for different sources of configuration with no defaults. The order in which you attach these configuration sources determines their priority in the hierarchy. Let's take a look at the options available to you

The priority of hierarchical configuration is defined like there :

1. Default configuration from @node-sitecore/config,
2. Arguments given by command line tools,
3. Environment variables,
4. From file .nscrc,
5. From .development.nscrc, .test.nscrc, .production.nscrc or [process.env.NODE_ENV].nscrc according to process.env.NODE_ENV value.

Getters

Config instance has getters to provide some shortcut to resolve a path based on the main configuration and your local machine configuration (Mac or Windows).

const config = require('@node-sitecore/config');

// getters
console.log(config.currentWebsite) // Custom
console.log(config.websiteRoot) // build/Website

Getters	Example value	Description
config.currentWebsite	Custom	Current website used by front-end and Sitecore
config.siteUrl	http://base.dev.local	Site url configured on your local machine. Use .development.nscrc
config.authConfigFile	build/Website/App_config/Include/Unicorn/Unicorn.UI.config	Path the unicorn script configuration.
config.instanceRoot	<rootDir>/build	Path to the Sitecore instance directory.
config.buildRoot	./build	Path to the Sitecore instance directory 1.
config.websiteRoot	path/to/build/Website	Path to the Website directory 1.
config.themeWebsiteRoot	path/to/build/Website/themes	Path to the themes directory 1.
config.currentWebsiteRoot	path/to/build/Website/themes/Custom	Path to the current Website directory 1.
config.sitecoreLibrariesRoot	path/to/build/Website/bin	Path to the Sitecore libraries directory 1.
config.licensePath	path/to/build/Data/license.xml	Path to the license file 1.
config.solutionPath	path/to/Base.sln	Path to the Visual Studio solution 1.
config.websiteViewsRoot	path/to/build/Website/Views	Path to the Views directory 1.
config.websiteConfigRoot	path/to/build/Website/App_Config	Path to the App_Config directory 1.
config.srcRoot	path/to/build/Website/src	Path to the source code directory 1.
config.foundationRoot	path/to/build/Website/src/Foundation	Path to the Foundation directory 1.
config.foundationScriptsRoot	path/to/build/Website/src/Foundation/Core/code/Scripts	Path to the Foundation script directory 1.
config.featureRoot	path/to/build/Website/src/Feature	Path to the Feature directory 1.
config.projectRoot	path/to/build/Website/src/Project	Path to the Project directory 1.
config.projectScriptsRoot	path/to/build/Website/src/Project/Custom/code/Scripts	Path to the current Project scripts directory 1.
config.currentProjectRoot	path/to/build/Website/src/Project/Custom/code	Path to the current Project directory 1.
config.directories	{}	deprecated.
config.moduleNameMapper	{}	module mapper configuration for jest.
config.bundles	{}	bundles configuration for webpack.
config.buildPaths	[<solutionPath>]	List of solutions or projects given to the command nsc build.
config.publishPaths	[<solutionPath>]	List of solutions or projects given to the command nsc publish.

<em>1<em> depending on local machine configuration.
## Contributing

Read our [contribution documentation](./CONTRIBUTING.md).

## License

The MIT License (MIT)

Copyright (c) 2018 NodeSitecore

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[travis]: https://travis-ci.org/