English description | Описание на русском
All builder configuration is in one file — tars-config.js at the root of the project.
You need to restart the build to apply changes.
Type: Array
Default: []
Example:
postcss: [
{
name: 'postcss-short',
options: {
deny: ['text']
}
}, {
name: 'postcss-size',
options: {}
}
]You can set all used postprocessors. Do not forget to install them.
Type: Object
Config for working with SVG in TARS.
Type: Boolean
Default: true
Activate svg-processing.
Type: String
Default: sprite
Available workflows of working with SVG in TARS. You can use SVG-sprite sprite and SVG-symbols symbols.
Build for IE8 won't be created then "symbols" is used
Type: Object
Config for working with SVG then "symbols" workflow is selected.
Type: String
Default: inject
This option sets type of svg-symbols loading workflow.
You can set:
- inject into the page code —
inject; - just separate file —
separate-file; - separate file with link for each use to that file —
separate-file-with-link.
Type: Boolean
Default: true
SVG-symbols loading from separate file is supported in all modern browsers natively except IE9 - Edge. You have to use polyfill for them. If you do not support IE, you can set false to this option.
Type: String
Default: ''
You can set a path to file with svg-symbols. File will be created in that directory, which was set in option. It will be created in the root of your build by default.
Possible value: static/images/.
Type: Object
Config for CSS processing in TARS.
Type: String
Default: concat
Type of CSS-code processing.
You can set:
concat— concatenation of all CSS-files into one bundle in a specific order;manual— you have to import all used files into entry points by yourself.
Type: Object
Config for JavaScript processing in TARS.
Type: String
Default: concat
Type of JavaScript-code processing.
You can set:
concat— concatenation of all JavaScript files into one bundle in specific order;modular— using bundler, which will resolve all dependencies between JavaScript-files.
Type: String
Default: webpack
You can specify bundler, if modular workflow is selected. Right now you can only choose webpack.
Type: Boolean
Default: true
Error checking in JavaScript code and code style (config for eslint is in the project root, in .eslintrc. See eslint options). Also, you can manually switch off linting of files and folders by using .eslintignore in the root of your project.
Type: Boolean
Default: false
This option allow to use Babel for ES6(ES7) syntax support. Config for Babel is in project root, in .babelrc. See babel options, except for sourcemaps and filename which are handled for you by default.
Type: Object
You can switch on/off additional cool features for webpack.
Type: Boolean
Default: false
Switch on/off Hot module replacement.
Type: Object
Default: {}
Provide Plugin options. Automatically loaded modules.
Type: Boolean
Default: true
Removing console.log and alerts from js files in the build. It's an option, because sometimes it is necessary to retain console.log in the complete build.
Type: Array of Strings
Default: []
This option makes sense only in case of using concat workflow. In that case all JavaScript code of the project is concatenated into one file except for JavaScript files located in the separate-js directory. If you want to include files from other locations into the build (for example, you created a separate directory for JavaScript files), you can register it in these options by adding a path or an array of paths (patterns paths, such as controllers/**/*.js) to JavaScript files. Files, which should be added to the build before main modules should be added in jsPathsToConcatBeforeModulesJs and after main modules in jsPathsToConcatAfterModulesJs
It will be useful for building a website on a JavaScript framework, which adds its own entities (such as controller, router, etc.). You do not need to go into tasks, just create a separate directory and specify for which files you want to watch.
Also you can disable eslint for these files (lintJsCodeBeforeModules and lintJsCodeAfterModules options).
Type: Object
Default:
sourcemaps: {
js: {
active: true,
inline: true
},
css: {
active: true,
inline: true
}
},Config for sourcemaps. Sourcemaps for JavaScript and CSS work only in dev mode. active {Boolean}: to use sourcemap or not. inline {Boolean}: to use sourcemap inlined into source-file or to use a separate file.
Config for notifications module.
When project files are changed there will be given a system notifications, which will indicate which file is changed and what task is executed.
Type: Boolean
Default: true
Enabling of notification. You can disable notifications by using environment variables:
export DISABLE_NOTIFIER=true;
# or
export NODE_ENV=production;Environment variables will overwrite useNotify value from tars-config.js
Type: String
Default: 'TARS notification'
Each notification has a title. If you want to see another title, you should change this option.
Sounds during the notifications.
Type: String, undefined
Default: undefined
In this option the name of the system sound is passed which will be played during the notification in case of a successful build. If you don't need the sounds, you can set it with undefined value.
Type: String, undefined
Default: undefined
In this option the name of the system sound is passed which will be played during the notification in case of a failed build. If you don't need the sounds, you can set it with undefined value.
Type: Boolean
Default: false
Enabling minifications for HTML. If is set to false, compiled html will be prettified.
Type: Boolean
Default: true
This option turns on autogeneration of a relative path to the static directory from the current page. In case of using a server or livereload, path to static won't be generated, because static files are served by the server.
Type: String
Default: './dev/'
You can set a string with a relative or an absolute path to the folder where the project should be built in development mode.
Using / after the path name is required so that there are no problems accessing the files.
Type: String
Default: './builds/'
You can set a string with a relative or an absolute path to the folder where the project should be built.
If you are using useBuildVersioning (use versioning of builds), each new build will be created in a separate folder with a name - the build version, and each folder will be created at the path specified in buildPath.
Using / after the path name is required so that there are no problems accessing the files.
Type: Boolean
Default: true
Use build versioning. The name of the version consists of the build name + date of creation (accurate to a second).
Type: Boolean
Default: true
Creating the archive of the build. The archive is created in the folder with the build. If project name is set in package.json, it will be used as the archive name, otherwise it will be build by default. The date of build creation will be also added to the name of the archive.
Type: Number
Default: 4096
By default, the number of simultaneously open files in the operating system (unix based) is limited. Since the TARS is working on Gulp, the number of simultaneously open files may be large. To avoid problems with that, you can set ulimit. If the project uses the large number of files and some of them do not get into the final build, then you can just increase this option.
These options can be changed before the command init only, because they don't influence any other command, besides useImagesForDisplayWithDpi. More info below.
Type: String
Default: handlebars
Options: jade, pug, handlebars
Used templater is specified in this option. Jade, pug and handlebars are available for now. The name of the templater is set in the option with a small letter.
If you want to write in plain HTML, retain the option unchanged.
Type: String
Default: scss
Options: scss, sass, less, stylus
Used css preprocessor is specified in this option.
Type: Array
Default: [96]
The pixel density of different screens, which will be supported by your project. Supported values are:
- 96 - 1 dppx (usual display)
- 192 - 2 dppx (retina display)
- 288 - 3 dppx (for example, nexus 5)
- 384 - 4 dppx (for example, nexus 6)
On the basis of this option, a folder for png images of different sizes for different screens is created. Read more in images processing docs.
This option can be changed at any time, but there is a couple of important points. If this option is changed after gulp|tars init, it is necessary to create (or delete) directories in the static/img/sprite/ folder by hand. The format of the folder name - option value + dpi. For example, 192dpi.
Options for main folders with static naming. If you change the option from this block after gulp|tars init or gulp|tars re-init, it is necessary to rename the appropriate directories by hand.
Type: String
Default: 'static'
The name of the folder where static files of the the project will be. If you are developing a project locally, it is necessary that the value of this option matches with the value of staticPrefix (deprecated) option.
Type: String
Default: 'img'
The name of the folder where images of the project will be. Usually this folder has different names, so setting it is optional.
Type: String
Default: 'components'
The name of the folder where components (modules for TARS 1.7.0 and below) of the the project will be.
Option is deprecated! Use svg.active
Type: Boolean
Default: true
Enabling svg-image support.
Option is deprecated! Value is set in tars/tars.js
Type: String
Default: ../imageFolderName/
Custom path to the folder with the static for css files. imageFolderName is taken from the imagesfoldername option.
Option has been renamed to lint and moved to js config object.
Configuration for autoprefixer (read more here). In short, this module allows you not to write vendor prefixes. In this configuration you do not need to include IE8 and IE9, style assembly is done by another way for them . You can look here which browsers are available. If you do not want to use autoprefixer, pass false in this option.
Option was moved to plugins-config.json.
Option was moved to .browserslistrc.
Config for the Browsersync module. This module implements the possibility livereload in browser, sharing the markup to an external web, creating a local server.
Options were moved to plugins-config.json. You can set any option, which is supported by browsersync.
The value of this option sets the value of the placeholder %=static=% or static, which can be used in any project files.
%=staticPrefix=% prefix works, but this prefix is deprecated! Use just %=static=% or static!
Option is deprecated! Value is set in tars/tars.js