-
Notifications
You must be signed in to change notification settings - Fork 0
/
mimosa-config.coffee
222 lines (201 loc) · 15.6 KB
/
mimosa-config.coffee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# All of the below are mimosa defaults and only need to be uncommented in the event you want
# to override them.
#
# IMPORTANT: Be sure to comment out all of the nodes from the base to the option you want to
# override. If you want to turn change the source directory you would need to uncomment watch
# and sourceDir. Also be sure to respect coffeescript indentation rules. 2 spaces per level
# please!
exports.config = {
# minMimosaVersion:null # The minimum Mimosa version that must be installed to use the
# project. Defaults to null, which means Mimosa will not check
# the version. This is a no-nonsense way for big teams to ensure
# everyone stays up to date with the blessed Mimosa version for a
# project.
###
The list of Mimosa modules to use for this application. The defaults (lint, server, require,
minify, live-reload) come bundled with Mimosa and do not need to be installed. The 'mimosa-'
that preceeds all Mimosa module names is assumed, however you can use it if you want. If a
module is listed here that Mimosa is unaware of, Mimosa will attempt to install it.
###
# modules: ['lint', 'server', 'require', 'minify', 'live-reload']
# watch:
# sourceDir: "assets" # directory location of web assets, can be relative to
# the project root, or absolute
# compiledDir: "public" # directory location of compiled web assets, can be
# relative to the project root, or absolute
# javascriptDir: "javascripts" # Location of precompiled javascript (i.e.
# coffeescript), must be relative to sourceDir
# exclude: [/[/\\](\.|~)[^/\\]+$/] # regexes or strings matching the files to be
# ignored by mimosa, the default matches all sorts of
# dot files and temp files. Strings are paths and can
# be relative to sourceDir or absolute.
# throttle: 0 # number of file adds the watcher handles before
# taking a 100 millisecond pause to let those files
# finish their processing. This helps avoid EMFILE
# issues for projects containing large numbers of
# files that all get copied at once. If the throttle
# is set to 0, no throttling is performed. Recommended
# to leave this set at 0, thedefault, until you start
# encountering EMFILE problems.
# compilers:
# extensionOverrides: # A list of extension overrides, format is:
# [compilerName]:[arrayOfExtensions], see
# http://mimosajs.com/compilers.html for list of compiler names
# coffee: ["coff"] # This is an example override, this is not a default, must be
# array of strings
# coffeescript: # config settings for coffeescript
# sourceMap:true # whether to generate source during "mimosa watch".
# Source maps are not generated during "mimosa build"
# regardless of setting.
# sourceMapExclude: [//spec//] # files to exclude from source map generation
# bare:true # whether or not to include the top level wrapper around
# each compiled coffeescript file. Defaults to not wrapping
# as wrapping with define/require is assumed.
# iced: # config settings for iced coffeescript
# bare:true # whether or not to include the top level wrapper around each
# compiled iced file. Defaults to not wrapping as wrapping with
# define/require is assumed.
# typescript: # config settings for typescript
# module: null # how compiled tyepscript is wrapped, defaults to no wrapping,
# can be "amd" or "commonjs"
# stylus: # config settings for stylus
# use:['nib'] # names of libraries to use, should match the npm name for
# the desired libraries
# template: # overall template object can be set to null if no
# templates being used
# amdWrap: true # Whether or not to wrap the compiled template files in
# an AMD wrapper for use with require.js
# outputFileName: "templates" # the file all templates are compiled into, is relative
# to watch.javascriptDir.
# outputFileName: # outputFileName Alternate Config 1
# hogan:"javascripts/hogans" # Optionally outputFileName can be provided an object of
# jade:"javascripts/jades" # file extension to file name in the event you are using
# multiple templating libraries. The file extension must
# match one of the default compiler extensions or one of
# the extensions configured for a compiler in the
# compilers.extensionOverrides section above.
# output: [{ # output Alternate Config 2
# folders:[""] # Use output instead of outputFileName if you want
# outputFileName: "" # to break up your templates into multiple files, for
# }] # instance, if you have a two page app and want the
# templates for each page to be built separately.
# For each entry, provide an array of folders that
# contain the templates to combine. folders entries are
# relative to watch.javascriptDir and must exist.
# outputFileName works identically to outputFileName
# above, including the alternate config, however, no
# default file name is assumed. An output name must be
# provided for each output entry, and the names
# must be unique.
# handlebars: # handlebars specific configuration
# helpers:["app/template/handlebars-helpers"] # the paths from watch.javascriptDir to
# the files containing handlebars helper/partial
# registrations
# ember: # Ember.js has its own Handlebars compilation needs,
# use this config block to provide Ember specific
# Handlebars configuration.
# enabled: false # Whether or not to use the Ember Handlebars compiler
# path: "vendor/ember" # location of the Ember library, this is used as
# as a dependency in the compiled templates.
###
# the extensions of files to copy from sourceDir to compiledDir. vendor js/css, images, etc.
###
# copy:
# extensions: ["js","css","png","jpg","jpeg","gif","html","eot","svg","ttf","woff","otf","yaml","kml","ico","htc","htm","json","txt","xml","xsd","map","md"]
# growl:
# onStartup: false # Controls whether or not to Growl when assets successfully
# compile/copy on startup, If you've got 100 CoffeeScript files,
# and you do a clean and then start watching, you'll get 100 Growl
# notifications. This is set to false by default to prevent that.
# Growling for every successful file on startup can also cause
# EMFILE issues. See watch.throttle
# onSuccess: # Controls whether to Growl when assets successfully compile/copy
# javascript: true # growl on successful compilation? will always send on failure
# css: true # growl on successful compilation? will always send on failure
# template: true # growl on successful compilation? will always send on failure
# copy: true # growl on successful copy?
server: # configuration for server when server option is enabled via CLI
defaultServer:
enabled: true # whether or not mimosa starts a default server for you, when
# true, mimosa starts its own on the port below, when false,
# Mimosa will use server provided by path below
# onePager: false # Whether or not your app is a one page application. When set to
# true, all routes will be pointed at index
# path: 'server.coffee' # valid when defaultServer.enabled: false, path to file for provided
# server which must contain export startServer method that takes
# an enriched mimosa-config object
# port: 3000 # port to start server on
# base: '' # base of url for the app, if altered should start with a slash
views: # configuration for the view layer of your application
compileWith: 'html' # Valid options: "jade", "hogan", "html", "ejs", "handlebars".
# The compiler for your views.
extension: 'html' # extension of your server views
# path: 'views' # This is the path to project views, it can be absolute or
# relative. If defaultServer.enabled is true, it is relative to the
# root of the project. If defaultServer.enabled is false it is
# relative to the server.path setting above.
# require: # configuration for requirejs options.
# commonConfig: "common" # The path from 'javascriptDir' to the location of common requirejs
# config. This is config shared across multiple requirejs modules.
# The should be or a requirejs.config({}) function call. Defaults
# to a file named `common` in the root of the javascriptDir. Does
# not need to exist, so can be left alone if a commonConfig is not
# being used.
# verify: # settings for requirejs path verification
# enabled: true # Whether or not to perform verification
# optimize :
# inferConfig:true # Mimosa figures out all you'd need for a simple r.js optimizer run.
# If you rather Mimosa not do that, set inferConfig to false and
# provide your config in the overrides section. See here
# https://github.com/dbashford/mimosa#requirejs-optimizer-defaults
# to see what the defaults are.
# overrides: # Optimization configuration and Mimosa overrides. If you need to
# make tweaks uncomment this line and add the r.js config
# (http://requirejs.org/docs/optimization.html#options) as new
# paramters inside the overrides ojbect. To unset Mimosa's defaults,
# set a property to null.
#
# overrides can also be a function that takes mimosa-require's
# inferred config for each module. This allows the inferred config
# to be updated and enhanced instead of just overridden.
# minify: # Configuration for non-require minification/compression via
# uglify using the --minify flag.
# exclude:[/\.min\./] # List of string paths and regexes to match files to exclude
# when running minification. Any path with ".min." in its name,
# like jquery.min.js, is assumed to already be minified and is
# ignored by default. Paths can be relative to the
# watch.compiledDir, or absolute. Paths are to compiled files,
# so '.js' rather than '.coffee'
# lint: # settings for js, css linting/hinting
# exclude:[] # array of strings or regexes that match files to not lint,
# strings are paths that can be relative to the watch.compiledDir
# or absolute
# compiled: # settings for compiled files
# javascript:true # fire jshint on successful compile of meta-language to javascript
# css:true # fire csslint on successful compile of meta-language to css
# copied: # settings for copied files, files already in .css and .js files
# javascript: true # fire jshint for copied javascript files
# css: true # fire csslint for copied css files
# vendor: # settings for vendor files
# javascript: false # fire jshint for copied vendor javascript files (like jquery)
# css: false # fire csslint for copied vendor css files (like bootstrap)
# rules: # All hints/lints come with defaults built in. Here is where
# you'd override those defaults. Below is listed an example of an
# overridden default for each lint type, also listed, next to the
# lint types is the url to find the settings for overriding.
# jshintrc: ".jshintrc" # This is the path, either relative to the root of the project or
# absolute, to a .jshintrc file. By default mimosa will look at
# the root of the project for this file. The file does not need to
# be present. If it is present, it must be valid JSON. To learn
# javascript: # Settings: http://www.jshint.com/options/, these settings will
# override any settings set up in the jshintrc
# plusplus: true # This is an example override, this is not a default
# css: # Settings: https://github.com/stubbornella/csslint/wiki/Rules
# floats: false # This is an example override, this is not a default
# liveReload: # Configuration for live-reload
# enabled:true # Whether or not live-reload is enabled
# additionalDirs:["views"] # Additional directories outside the watch.compiledDir
# that you would like to have trigger a page refresh,
# like, by default, static views. Is string path,
# can be relative to project root, or absolute
}