Skip to content

Commit 5cbfb51

Browse files
author
deepsweet
committedSep 28, 2014
init
·
v1.0.0
0 parents  commit 5cbfb51

17 files changed

+506
-0
lines changed
 

‎.editorconfig

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
; editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 4
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.json]
13+
indent_size = 2
14+
15+
[*.yml]
16+
indent_size = 2
17+
18+
[*.md]
19+
indent_size = 2
20+
21+
[{.eslintrc,.jscsrc}]
22+
indent_size = 2

‎.eslintrc

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
# https://github.com/eslint/eslint/blob/master/docs/configuring/README.md
3+
4+
env:
5+
node: true
6+
browser: true
7+
8+
# https://github.com/eslint/eslint/tree/master/docs/rules
9+
rules:
10+
# possible errors
11+
no-cond-assign: 1
12+
no-console: 1
13+
no-constant-condition: 2
14+
no-comma-dangle: 1
15+
no-control-regex: 1
16+
no-debugger: 2
17+
no-dupe-keys: 2
18+
no-empty: 2
19+
no-empty-class: 2
20+
no-ex-assign: 2
21+
no-extra-boolean-cast: 1
22+
no-extra-parens: 1
23+
no-extra-semi: 2
24+
no-func-assign: 2
25+
no-inner-declarations: 1
26+
no-invalid-regexp: 2
27+
no-negated-in-lhs: 1
28+
no-obj-calls: 2
29+
no-regex-spaces: 1
30+
no-sparse-arrays: 2
31+
no-unreachable: 2
32+
use-isnan: 2
33+
valid-jsdoc: 1
34+
valid-typeof: 2
35+
36+
# best practices
37+
block-scoped-var: 1
38+
complexity: 0
39+
consistent-return: 1
40+
curly: 2
41+
default-case: 1
42+
dot-notation: 0
43+
eqeqeq: 2
44+
guard-for-in: 1
45+
no-alert: 2
46+
no-caller: 2
47+
no-div-regex: 0
48+
no-else-return: 1
49+
no-empty-label: 2
50+
no-eq-null: 2
51+
no-eval: 2
52+
no-extend-native: 2
53+
no-fallthrough: 1
54+
no-floating-decimal: 1
55+
no-implied-eval: 2
56+
no-labels: 2
57+
no-iterator: 2
58+
no-lone-blocks: 2
59+
no-loop-func: 1
60+
no-multi-str: 1
61+
no-native-reassign: 2
62+
no-new: 0
63+
no-new-func: 2
64+
no-new-wrappers: 1
65+
no-octal: 2
66+
no-octal-escape: 2
67+
no-proto: 2
68+
no-redeclare: 2
69+
no-return-assign: 2
70+
no-script-url: 2
71+
no-self-compare: 2
72+
no-sequences: 1
73+
no-unused-expressions: 2
74+
# Definition for rule 'no-void' was not found
75+
# no-void: 2
76+
no-warning-comments: 0
77+
no-with: 2
78+
radix: 1
79+
wrap-iife: 1
80+
yoda: 0
81+
82+
# strict mode
83+
# Definition for rule 'global-strict' was not found
84+
# global-strict: [2, "always"]
85+
no-extra-strict: 2
86+
strict: 2
87+
88+
# variables
89+
no-catch-shadow: 2
90+
no-delete-var: 2
91+
no-label-var: 2
92+
no-shadow: 1
93+
no-shadow-restricted-names: 2
94+
no-undef: 2
95+
no-undefined: 2
96+
no-undef-init: 1
97+
no-unused-vars: 1
98+
no-use-before-define: 2
99+
100+
# Node.js
101+
handle-callback-err: 2
102+
no-mixed-requires: 0
103+
no-path-concat: 2
104+
no-process-exit: 2
105+
no-restricted-modules: 0
106+
no-sync: 0
107+
108+
# stylistic issues, disabled because of JSCS
109+
brace-style: 0
110+
camelcase: 0
111+
consistent-this: 0
112+
eol-last: 0
113+
func-names: 0
114+
func-style: 0
115+
new-cap: 1
116+
new-parens: 1
117+
no-nested-ternary: 0
118+
no-array-constructor: 1
119+
no-lonely-if: 1
120+
no-new-object: 1
121+
no-spaced-func: 0
122+
no-space-before-semi: 0
123+
no-ternary: 0
124+
no-trailing-spaces: 0
125+
no-underscore-dangle: 0
126+
no-wrap-func: 0
127+
no-mixed-spaces-and-tabs: 0
128+
quotes: 0
129+
quote-props: 0
130+
semi: 2
131+
sort-vars: 0
132+
space-after-keywords: 0
133+
space-in-brackets: 0
134+
space-in-parens: 0
135+
space-infix-ops: 0
136+
space-return-throw-case: 1
137+
space-unary-word-ops: 1
138+
max-nested-callbacks: 0
139+
one-var: 0
140+
wrap-regex: 0

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
tmp/
3+
*.sublime-*
4+
*.log
5+
.DS_Store

‎.jscsrc

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
{
2+
"requireCurlyBraces": [
3+
"if",
4+
"else",
5+
"for",
6+
"while",
7+
"do",
8+
"try",
9+
"catch",
10+
"case",
11+
"default"
12+
],
13+
"requireSpaceAfterKeywords": [
14+
"if",
15+
"else",
16+
"for",
17+
"while",
18+
"do",
19+
"switch",
20+
"return",
21+
"try",
22+
"catch"
23+
],
24+
"requireSpaceBeforeBlockStatements": true,
25+
"requireParenthesesAroundIIFE": true,
26+
"requireSpacesInConditionalExpression": {
27+
"afterTest": true,
28+
"beforeConsequent": true,
29+
"afterConsequent": true,
30+
"beforeAlternate": true
31+
},
32+
"requireSpacesInAnonymousFunctionExpression": {
33+
"beforeOpeningCurlyBrace": true
34+
},
35+
"disallowSpacesInAnonymousFunctionExpression": {
36+
"beforeOpeningRoundBrace": true
37+
},
38+
"requireSpacesInNamedFunctionExpression": {
39+
"beforeOpeningCurlyBrace": true
40+
},
41+
"disallowSpacesInNamedFunctionExpression": {
42+
"beforeOpeningRoundBrace": true
43+
},
44+
"requireBlocksOnNewline": true,
45+
"requireSpacesInsideObjectBrackets": "all",
46+
"requireSpacesInsideArrayBrackets": "all",
47+
"disallowSpaceAfterObjectKeys": true,
48+
"requireCommaBeforeLineBreak": true,
49+
"requireOperatorBeforeLineBreak": [
50+
"?",
51+
"=",
52+
"+",
53+
"-",
54+
"/",
55+
"*",
56+
"==",
57+
"===",
58+
"!=",
59+
"!==",
60+
">",
61+
">=",
62+
"<",
63+
"<="
64+
],
65+
"disallowSpaceAfterPrefixUnaryOperators": [ "++", "--", "+", "-", "~", "!" ],
66+
"disallowSpaceBeforePostfixUnaryOperators": [ "++", "--" ],
67+
"requireSpaceBeforeBinaryOperators": [
68+
"=",
69+
"+",
70+
"-",
71+
"/",
72+
"*",
73+
"==",
74+
"===",
75+
"!=",
76+
"!=="
77+
],
78+
"requireSpaceAfterBinaryOperators": [
79+
"=",
80+
",",
81+
"+",
82+
"-",
83+
"/",
84+
"*",
85+
"==",
86+
"===",
87+
"!=",
88+
"!=="
89+
],
90+
"requireCamelCaseOrUpperCaseIdentifiers": true,
91+
"disallowMultipleLineBreaks": true,
92+
"validateLineBreaks": "LF",
93+
"validateQuoteMarks": "'",
94+
"validateIndentation": 4,
95+
"disallowMixedSpacesAndTabs": true,
96+
"disallowTrailingWhitespace": true,
97+
"disallowTrailingComma": true,
98+
"disallowKeywordsOnNewLine": ["else"],
99+
"requireLineFeedAtFileEnd": true,
100+
"requireCapitalizedConstructors": true,
101+
"safeContextKeyword": ["that"],
102+
"disallowYodaConditions": true,
103+
"requireSpaceAfterLineComment": true,
104+
"requireAnonymousFunctions": true,
105+
"disallowNewlineBeforeBlockStatements": true,
106+
"disallowMultipleVarDecl": true
107+
}

‎.npmignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.gitignore
2+
.editorconfig
3+
.eslintrc
4+
.jscsrc
5+
.travis.yml
6+
tmp/
7+
*.sublime-*
8+
*.log
9+
.DS_Store

‎.travis.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
language: node_js
2+
3+
node_js:
4+
- 0.10
5+
- 0.11
6+
7+
matrix:
8+
allow_failures:
9+
- node_js: 0.11
10+
11+
branches:
12+
only:
13+
- master

‎README.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
## "Baggage" loader for [webpack](https://webpack.github.io/)
2+
3+
[![travis](http://img.shields.io/travis/deepsweet/baggage-loader.svg?style=flat-square)](https://travis-ci.org/deepsweet/baggage-loader)
4+
[![npm](http://img.shields.io/npm/v/baggage-loader.svg?style=flat-square)](https://www.npmjs.org/package/baggage-loader)
5+
[![peer deps](http://img.shields.io/david/peer/deepsweet/baggage-loader.svg?style=flat-square)](https://david-dm.org/deepsweet/baggage-loader#info=peerDependencies)
6+
[![dev deps](http://img.shields.io/david/dev/deepsweet/baggage-loader.svg?style=flat-square)](https://david-dm.org/deepsweet/baggage-loader#info=devDependencies)
7+
![unicorn approved](http://img.shields.io/badge/unicorn-approved-ff69b4.svg?style=flat-square)
8+
9+
Automatically `require()` any resources related to the `require()`d one. See example below.
10+
11+
[Documentation: Using loaders](https://webpack.github.io/docs/using-loaders.html).
12+
13+
### Install
14+
15+
```sh
16+
npm i -S baggage-loader
17+
```
18+
19+
### Usage
20+
21+
Imagine that you have project structure like this and you're using webpack:
22+
23+
```
24+
components/
25+
├── component-1
26+
│   ├── script.js
27+
│   ├── styles.css
28+
│   └── template.html
29+
├── component-2
30+
│   ├── script.js
31+
│   └── template.html
32+
└── component-3
33+
├── script.js
34+
└── styles.css
35+
```
36+
37+
and in each of component's `script.js` you're doing something like this:
38+
39+
```javascript
40+
var template = require('./template.html');
41+
require('./styles.css');
42+
43+
var html = template({ foo: 'bar' };
44+
```
45+
46+
Now you have to stop and give it to `baggage-loader`, so:
47+
48+
```javascript
49+
module: {
50+
preLoaders: [ {
51+
test: /\/components\/.+script\.js$/,
52+
// baggage?file=var&file-without-var&…
53+
loader: 'baggage?template.html=template&styles.css'
54+
} ],
55+
}
56+
```
57+
58+
will become the necessary `require()`s with variables declarations if corresponding files exists:
59+
60+
```javascript
61+
// injected by preloader at the top of script.js
62+
var template = require('./template.html');
63+
require('./styles.css');
64+
65+
// your code
66+
var html = template({ foo: 'bar' };
67+
```
68+
69+
Even more, there are placeholders `[dir]`, `[Dir]`, `[file]` and `[File]`, so you can use them in various tricky ways both with `file` and `var`:
70+
71+
```
72+
└── alert
73+
├── view.js
74+
├── templateAlert.html
75+
└── alertViewStyles.css
76+
```
77+
78+
```javascript
79+
loader: 'baggage?template[Dir].html=[file]Template&[dir][File].css'
80+
```
81+
82+
```javascript
83+
var viewTemplate = require('./templateAlert.html');
84+
require('./alertViewStyles.css');
85+
```
86+
87+
### Test
88+
89+
Soon.
90+
91+
`npm test`
92+
93+
### License
94+
[WTFPL](http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-strip.jpg)

‎components/component-1/script.js

Whitespace-only changes.

‎components/component-1/styles.css

Whitespace-only changes.

‎components/component-1/template.html

Whitespace-only changes.

‎components/component-2/script.js

Whitespace-only changes.

‎components/component-2/template.html

Whitespace-only changes.

‎components/component-3/script.js

Whitespace-only changes.

‎components/component-3/styles.css

Whitespace-only changes.

‎index.js

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
'use strict';
2+
3+
var path = require('path');
4+
var fs = require('fs');
5+
var loaderUtils = require('loader-utils');
6+
7+
var util = require('./lib/util');
8+
9+
module.exports = function(source) {
10+
var query = loaderUtils.parseQuery(this.query);
11+
var inject = '';
12+
13+
// /foo/bar/file.js
14+
var srcFilepath = this.resourcePath;
15+
// /foo/bar/file.js -> file
16+
var srcFilename = path.basename(srcFilepath, path.extname(srcFilepath));
17+
// /foo/bar/file.js -> /foo/bar
18+
var srcDirpath = path.dirname(srcFilepath);
19+
// /foo/bar -> bar
20+
var srcDirname = srcDirpath.split(path.sep).pop();
21+
22+
if (this.cacheable) {
23+
this.cacheable();
24+
}
25+
26+
for (var baggageFile in query) {
27+
if (query.hasOwnProperty(baggageFile)) {
28+
var baggageVar = query[baggageFile];
29+
30+
// TODO: not so quick and dirty validation
31+
if (typeof baggageVar === 'string' || baggageVar === true) {
32+
// apply filename placeholders
33+
baggageFile = util.applyPlaceholders(baggageFile, srcDirname, srcFilename);
34+
35+
// apply var placeholders
36+
if (baggageVar.length) {
37+
baggageVar = util.applyPlaceholders(baggageVar, srcDirname, srcFilename);
38+
}
39+
40+
try {
41+
// check if absoluted from srcDirpath + baggageFile path exists
42+
var stats = fs.statSync(path.resolve(srcDirpath, baggageFile));
43+
44+
if (stats.isFile()) {
45+
// assign it to variable
46+
if (baggageVar.length) {
47+
inject += 'var ' + baggageVar + ' = ';
48+
}
49+
50+
// and require
51+
inject += 'require("./' + baggageFile + '");\n';
52+
}
53+
} catch (e) {}
54+
}
55+
}
56+
}
57+
58+
// inject collected string at the top of file
59+
if (inject) {
60+
return inject + '\n' + source;
61+
}
62+
63+
return source;
64+
};

‎lib/util.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
'use strict';
2+
3+
var capitalize = exports.capitalize = function(str) {
4+
return str.charAt(0).toUpperCase() + str.slice(1);
5+
};
6+
7+
exports.applyPlaceholders = function(str, dirname, filename) {
8+
if (!str.length) {
9+
return str;
10+
}
11+
12+
return str
13+
.split('[dir]').join(dirname)
14+
.split('[Dir]').join(capitalize(dirname))
15+
.split('[file]').join(filename)
16+
.split('[File]').join(capitalize(filename));
17+
};

‎package.json

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{
2+
"name": "baggage-loader",
3+
"version": "0.1.0",
4+
"description": "webpack loader to automatically require any resources related to the required one",
5+
"keywords": [
6+
"webpack",
7+
"loader"
8+
],
9+
"homepage": "https://github.com/deepsweet/baggage-loader",
10+
"repository": {
11+
"type": "git",
12+
"url": "git://github.com/deepsweet/baggage-loader.git"
13+
},
14+
"author": {
15+
"name": "Kir Belevich",
16+
"email": "kir@soulshine.in",
17+
"url": "https://github.com/deepsweet"
18+
},
19+
"main": "index.js",
20+
"peerDependencies": {
21+
"webpack": "^1.4.3",
22+
"loader-utils": "^0.2.4"
23+
},
24+
"devDependencies": {
25+
"eslint": "^0.8.2",
26+
"jscs": "^1.6.2"
27+
},
28+
"scripts": {
29+
"test": "eslint index.js lib/*.js && jscs index.js lib/*.js"
30+
},
31+
"engines": {
32+
"node": ">=0.10.0"
33+
},
34+
"license": "WTFPL"
35+
}

0 commit comments

Comments
 (0)
Please sign in to comment.