Update readme to start project correctly
Change csscomb json file location change package json node modules to 0.0.0
This commit is contained in:
stephenbe
15
README.md
15
README.md
@@ -4,6 +4,21 @@ Charcoal-Boilerplate
|
|||||||
Boilerplate for [`Charcoal`](#http://charcoal.locomotive.ca) projects by Locomotive.
|
Boilerplate for [`Charcoal`](#http://charcoal.locomotive.ca) projects by Locomotive.
|
||||||
|
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
###Get the latest node modules
|
||||||
|
We are using this module to get the latest version of every modules and update the package.json
|
||||||
|
|
||||||
|
`npm install -g npm-check-updates`
|
||||||
|
|
||||||
|
`npm-check-updates -u`
|
||||||
|
|
||||||
|
`npm install`
|
||||||
|
|
||||||
|
|
||||||
|
###Run grunt and start coding
|
||||||
|
`grunt`
|
||||||
|
|
||||||
## SCSS
|
## SCSS
|
||||||
|
|
||||||
### Import order
|
### Import order
|
||||||
|
|||||||
321
project-x/modules/boilerplate/.csscomb.json
Normal file
321
project-x/modules/boilerplate/.csscomb.json
Normal file
@@ -0,0 +1,321 @@
|
|||||||
|
{
|
||||||
|
"always-semicolon": true,
|
||||||
|
"color-case": "lower",
|
||||||
|
"block-indent": "\t",
|
||||||
|
"color-shorthand": false,
|
||||||
|
"eof-newline": true,
|
||||||
|
"leading-zero": true,
|
||||||
|
"quotes": "double",
|
||||||
|
"space-before-colon": "",
|
||||||
|
"space-after-colon": " ",
|
||||||
|
"space-before-combinator": " ",
|
||||||
|
"space-after-combinator": " ",
|
||||||
|
"space-between-declarations": "\n",
|
||||||
|
"space-before-opening-brace": " ",
|
||||||
|
"space-after-opening-brace": "\n",
|
||||||
|
"space-before-selector-delimiter": "",
|
||||||
|
"space-before-closing-brace": "\n",
|
||||||
|
"strip-spaces": true,
|
||||||
|
"unitless-zero": true,
|
||||||
|
"vendor-prefix-align": true,
|
||||||
|
"sort-order": [
|
||||||
|
[
|
||||||
|
"font",
|
||||||
|
"font-family",
|
||||||
|
"font-size",
|
||||||
|
"font-weight",
|
||||||
|
"font-style",
|
||||||
|
"font-variant",
|
||||||
|
"font-size-adjust",
|
||||||
|
"font-stretch",
|
||||||
|
"font-effect",
|
||||||
|
"font-emphasize",
|
||||||
|
"font-emphasize-position",
|
||||||
|
"font-emphasize-style",
|
||||||
|
"font-smooth",
|
||||||
|
"line-height"
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"position",
|
||||||
|
"z-index",
|
||||||
|
"top",
|
||||||
|
"right",
|
||||||
|
"bottom",
|
||||||
|
"left"
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"display",
|
||||||
|
"visibility",
|
||||||
|
"float",
|
||||||
|
"clear",
|
||||||
|
"overflow",
|
||||||
|
"overflow-x",
|
||||||
|
"overflow-y",
|
||||||
|
"-ms-overflow-x",
|
||||||
|
"-ms-overflow-y",
|
||||||
|
"clip",
|
||||||
|
"zoom",
|
||||||
|
"flex-direction",
|
||||||
|
"flex-order",
|
||||||
|
"flex-pack",
|
||||||
|
"flex-align"
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"-webkit-box-sizing",
|
||||||
|
"-moz-box-sizing",
|
||||||
|
"box-sizing",
|
||||||
|
"width",
|
||||||
|
"min-width",
|
||||||
|
"max-width",
|
||||||
|
"height",
|
||||||
|
"min-height",
|
||||||
|
"max-height",
|
||||||
|
"margin",
|
||||||
|
"margin-top",
|
||||||
|
"margin-right",
|
||||||
|
"margin-bottom",
|
||||||
|
"margin-left",
|
||||||
|
"padding",
|
||||||
|
"padding-top",
|
||||||
|
"padding-right",
|
||||||
|
"padding-bottom",
|
||||||
|
"padding-left"
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"table-layout",
|
||||||
|
"empty-cells",
|
||||||
|
"caption-side",
|
||||||
|
"border-spacing",
|
||||||
|
"border-collapse",
|
||||||
|
"list-style",
|
||||||
|
"list-style-position",
|
||||||
|
"list-style-type",
|
||||||
|
"list-style-image"
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"content",
|
||||||
|
"quotes",
|
||||||
|
"counter-reset",
|
||||||
|
"counter-increment",
|
||||||
|
"resize",
|
||||||
|
"cursor",
|
||||||
|
"-webkit-user-select",
|
||||||
|
"-moz-user-select",
|
||||||
|
"-ms-user-select",
|
||||||
|
"user-select",
|
||||||
|
"nav-index",
|
||||||
|
"nav-up",
|
||||||
|
"nav-right",
|
||||||
|
"nav-down",
|
||||||
|
"nav-left",
|
||||||
|
"-webkit-transition",
|
||||||
|
"-moz-transition",
|
||||||
|
"-ms-transition",
|
||||||
|
"-o-transition",
|
||||||
|
"transition",
|
||||||
|
"-webkit-transition-delay",
|
||||||
|
"-moz-transition-delay",
|
||||||
|
"-ms-transition-delay",
|
||||||
|
"-o-transition-delay",
|
||||||
|
"transition-delay",
|
||||||
|
"-webkit-transition-timing-function",
|
||||||
|
"-moz-transition-timing-function",
|
||||||
|
"-ms-transition-timing-function",
|
||||||
|
"-o-transition-timing-function",
|
||||||
|
"transition-timing-function",
|
||||||
|
"-webkit-transition-duration",
|
||||||
|
"-moz-transition-duration",
|
||||||
|
"-ms-transition-duration",
|
||||||
|
"-o-transition-duration",
|
||||||
|
"transition-duration",
|
||||||
|
"-webkit-transition-property",
|
||||||
|
"-moz-transition-property",
|
||||||
|
"-ms-transition-property",
|
||||||
|
"-o-transition-property",
|
||||||
|
"transition-property",
|
||||||
|
"-webkit-transform",
|
||||||
|
"-moz-transform",
|
||||||
|
"-ms-transform",
|
||||||
|
"-o-transform",
|
||||||
|
"transform",
|
||||||
|
"-webkit-transform-origin",
|
||||||
|
"-moz-transform-origin",
|
||||||
|
"-ms-transform-origin",
|
||||||
|
"-o-transform-origin",
|
||||||
|
"transform-origin",
|
||||||
|
"-webkit-animation",
|
||||||
|
"-moz-animation",
|
||||||
|
"-ms-animation",
|
||||||
|
"-o-animation",
|
||||||
|
"animation",
|
||||||
|
"-webkit-animation-name",
|
||||||
|
"-moz-animation-name",
|
||||||
|
"-ms-animation-name",
|
||||||
|
"-o-animation-name",
|
||||||
|
"animation-name",
|
||||||
|
"-webkit-animation-duration",
|
||||||
|
"-moz-animation-duration",
|
||||||
|
"-ms-animation-duration",
|
||||||
|
"-o-animation-duration",
|
||||||
|
"animation-duration",
|
||||||
|
"-webkit-animation-play-state",
|
||||||
|
"-moz-animation-play-state",
|
||||||
|
"-ms-animation-play-state",
|
||||||
|
"-o-animation-play-state",
|
||||||
|
"animation-play-state",
|
||||||
|
"-webkit-animation-timing-function",
|
||||||
|
"-moz-animation-timing-function",
|
||||||
|
"-ms-animation-timing-function",
|
||||||
|
"-o-animation-timing-function",
|
||||||
|
"animation-timing-function",
|
||||||
|
"-webkit-animation-delay",
|
||||||
|
"-moz-animation-delay",
|
||||||
|
"-ms-animation-delay",
|
||||||
|
"-o-animation-delay",
|
||||||
|
"animation-delay",
|
||||||
|
"-webkit-animation-iteration-count",
|
||||||
|
"-moz-animation-iteration-count",
|
||||||
|
"-ms-animation-iteration-count",
|
||||||
|
"-o-animation-iteration-count",
|
||||||
|
"animation-iteration-count",
|
||||||
|
"-webkit-animation-direction",
|
||||||
|
"-moz-animation-direction",
|
||||||
|
"-ms-animation-direction",
|
||||||
|
"-o-animation-direction",
|
||||||
|
"animation-direction",
|
||||||
|
"text-align",
|
||||||
|
"-webkit-text-align-last",
|
||||||
|
"-moz-text-align-last",
|
||||||
|
"-ms-text-align-last",
|
||||||
|
"text-align-last",
|
||||||
|
"vertical-align",
|
||||||
|
"white-space",
|
||||||
|
"text-decoration",
|
||||||
|
"text-emphasis",
|
||||||
|
"text-emphasis-color",
|
||||||
|
"text-emphasis-style",
|
||||||
|
"text-emphasis-position",
|
||||||
|
"text-indent",
|
||||||
|
"-ms-text-justify",
|
||||||
|
"text-justify",
|
||||||
|
"letter-spacing",
|
||||||
|
"word-spacing",
|
||||||
|
"-ms-writing-mode",
|
||||||
|
"text-outline",
|
||||||
|
"text-transform",
|
||||||
|
"text-wrap",
|
||||||
|
"text-overflow",
|
||||||
|
"-ms-text-overflow",
|
||||||
|
"text-overflow-ellipsis",
|
||||||
|
"text-overflow-mode",
|
||||||
|
"-ms-word-wrap",
|
||||||
|
"word-wrap",
|
||||||
|
"word-break",
|
||||||
|
"-ms-word-break",
|
||||||
|
"-moz-tab-size",
|
||||||
|
"-o-tab-size",
|
||||||
|
"tab-size",
|
||||||
|
"-webkit-hyphens",
|
||||||
|
"-moz-hyphens",
|
||||||
|
"hyphens",
|
||||||
|
"pointer-events"
|
||||||
|
],
|
||||||
|
[
|
||||||
|
"opacity",
|
||||||
|
"filter:progid:DXImageTransform.Microsoft.Alpha(Opacity",
|
||||||
|
"-ms-filter:\\'progid:DXImageTransform.Microsoft.Alpha",
|
||||||
|
"-ms-interpolation-mode",
|
||||||
|
"color",
|
||||||
|
"border",
|
||||||
|
"border-width",
|
||||||
|
"border-style",
|
||||||
|
"border-color",
|
||||||
|
"border-top",
|
||||||
|
"border-top-width",
|
||||||
|
"border-top-style",
|
||||||
|
"border-top-color",
|
||||||
|
"border-right",
|
||||||
|
"border-right-width",
|
||||||
|
"border-right-style",
|
||||||
|
"border-right-color",
|
||||||
|
"border-bottom",
|
||||||
|
"border-bottom-width",
|
||||||
|
"border-bottom-style",
|
||||||
|
"border-bottom-color",
|
||||||
|
"border-left",
|
||||||
|
"border-left-width",
|
||||||
|
"border-left-style",
|
||||||
|
"border-left-color",
|
||||||
|
"-webkit-border-radius",
|
||||||
|
"-moz-border-radius",
|
||||||
|
"border-radius",
|
||||||
|
"-webkit-border-top-left-radius",
|
||||||
|
"-moz-border-radius-topleft",
|
||||||
|
"border-top-left-radius",
|
||||||
|
"-webkit-border-top-right-radius",
|
||||||
|
"-moz-border-radius-topright",
|
||||||
|
"border-top-right-radius",
|
||||||
|
"-webkit-border-bottom-right-radius",
|
||||||
|
"-moz-border-radius-bottomright",
|
||||||
|
"border-bottom-right-radius",
|
||||||
|
"-webkit-border-bottom-left-radius",
|
||||||
|
"-moz-border-radius-bottomleft",
|
||||||
|
"border-bottom-left-radius",
|
||||||
|
"-webkit-border-image",
|
||||||
|
"-moz-border-image",
|
||||||
|
"-o-border-image",
|
||||||
|
"border-image",
|
||||||
|
"-webkit-border-image-source",
|
||||||
|
"-moz-border-image-source",
|
||||||
|
"-o-border-image-source",
|
||||||
|
"border-image-source",
|
||||||
|
"-webkit-border-image-slice",
|
||||||
|
"-moz-border-image-slice",
|
||||||
|
"-o-border-image-slice",
|
||||||
|
"border-image-slice",
|
||||||
|
"-webkit-border-image-width",
|
||||||
|
"-moz-border-image-width",
|
||||||
|
"-o-border-image-width",
|
||||||
|
"border-image-width",
|
||||||
|
"-webkit-border-image-outset",
|
||||||
|
"-moz-border-image-outset",
|
||||||
|
"-o-border-image-outset",
|
||||||
|
"border-image-outset",
|
||||||
|
"-webkit-border-image-repeat",
|
||||||
|
"-moz-border-image-repeat",
|
||||||
|
"-o-border-image-repeat",
|
||||||
|
"border-image-repeat",
|
||||||
|
"outline",
|
||||||
|
"outline-width",
|
||||||
|
"outline-style",
|
||||||
|
"outline-color",
|
||||||
|
"outline-offset",
|
||||||
|
"background",
|
||||||
|
"filter:progid:DXImageTransform.Microsoft.AlphaImageLoader",
|
||||||
|
"background-color",
|
||||||
|
"background-image",
|
||||||
|
"background-repeat",
|
||||||
|
"background-attachment",
|
||||||
|
"background-position",
|
||||||
|
"background-position-x",
|
||||||
|
"-ms-background-position-x",
|
||||||
|
"background-position-y",
|
||||||
|
"-ms-background-position-y",
|
||||||
|
"-webkit-background-clip",
|
||||||
|
"-moz-background-clip",
|
||||||
|
"background-clip",
|
||||||
|
"background-origin",
|
||||||
|
"-webkit-background-size",
|
||||||
|
"-moz-background-size",
|
||||||
|
"-o-background-size",
|
||||||
|
"background-size",
|
||||||
|
"box-decoration-break",
|
||||||
|
"-webkit-box-shadow",
|
||||||
|
"-moz-box-shadow",
|
||||||
|
"box-shadow",
|
||||||
|
"filter:progid:DXImageTransform.Microsoft.gradient",
|
||||||
|
"-ms-filter:\\'progid:DXImageTransform.Microsoft.gradient",
|
||||||
|
"text-shadow"
|
||||||
|
]
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -4,7 +4,7 @@ module.exports = function(grunt) {
|
|||||||
|
|
||||||
pkg: grunt.file.readJSON('package.json'),
|
pkg: grunt.file.readJSON('package.json'),
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
// sass: Compile Sass to CSS
|
// sass: Compile Sass to CSS
|
||||||
sass: require('./grunt_tasks/sass'),
|
sass: require('./grunt_tasks/sass'),
|
||||||
@@ -89,7 +89,7 @@ module.exports = function(grunt) {
|
|||||||
// csscomb: Sort CSS properties in specific order.
|
// csscomb: Sort CSS properties in specific order.
|
||||||
csscomb: {
|
csscomb: {
|
||||||
options: {
|
options: {
|
||||||
config: 'grunt_tasks/.csscomb.json'
|
config: '.csscomb.json'
|
||||||
},
|
},
|
||||||
build: {
|
build: {
|
||||||
expand: true,
|
expand: true,
|
||||||
|
|||||||
@@ -6,21 +6,21 @@
|
|||||||
"Stephen Bégay <stephen@locomotive.ca>",
|
"Stephen Bégay <stephen@locomotive.ca>",
|
||||||
"Antoine Boulanger <antoine@locomotive.ca>"
|
"Antoine Boulanger <antoine@locomotive.ca>"
|
||||||
],
|
],
|
||||||
"dependencies": {
|
"devDependencies": {
|
||||||
"grunt": "*",
|
"grunt": "0.0.0",
|
||||||
"grunt-autoprefixer": "*",
|
"grunt-autoprefixer": "0.0.0",
|
||||||
"grunt-contrib-concat": "*",
|
"grunt-contrib-concat": "0.0.0",
|
||||||
"grunt-contrib-cssmin": "*",
|
"grunt-contrib-cssmin": "0.0.0",
|
||||||
"grunt-contrib-imagemin": "*",
|
"grunt-contrib-imagemin": "0.0.0",
|
||||||
"grunt-contrib-jshint": "*",
|
"grunt-contrib-jshint": "0.0.0",
|
||||||
"grunt-contrib-uglify": "*",
|
"grunt-contrib-uglify": "0.0.0",
|
||||||
"grunt-contrib-watch": "*",
|
"grunt-contrib-watch": "0.0.0",
|
||||||
"grunt-csscomb": "*",
|
"grunt-csscomb": "0.0.0",
|
||||||
"grunt-jsonlint": "*",
|
"grunt-jsonlint": "0.0.0",
|
||||||
"grunt-notify": "*",
|
"grunt-notify": "0.0.0",
|
||||||
"grunt-phplint": "*",
|
"grunt-phplint": "0.0.0",
|
||||||
"grunt-sass": "*",
|
"grunt-sass": "0.0.0",
|
||||||
"grunt-svgmin": "*",
|
"grunt-svgmin": "0.0.0",
|
||||||
"grunt-svgstore": "*"
|
"grunt-svgstore": "0.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user