replace zxq.co/ripple/hanayo
This commit is contained in:
Alicia
189
semantic/tasks/docs/build.js
Normal file
189
semantic/tasks/docs/build.js
Normal file
@@ -0,0 +1,189 @@
|
||||
/*******************************
|
||||
Build Docs
|
||||
*******************************/
|
||||
|
||||
var
|
||||
gulp = require('gulp'),
|
||||
|
||||
// node dependencies
|
||||
console = require('better-console'),
|
||||
fs = require('fs'),
|
||||
map = require('map-stream'),
|
||||
|
||||
// gulp dependencies
|
||||
autoprefixer = require('gulp-autoprefixer'),
|
||||
chmod = require('gulp-chmod'),
|
||||
clone = require('gulp-clone'),
|
||||
flatten = require('gulp-flatten'),
|
||||
gulpif = require('gulp-if'),
|
||||
header = require('gulp-header'),
|
||||
less = require('gulp-less'),
|
||||
minifyCSS = require('gulp-clean-css'),
|
||||
plumber = require('gulp-plumber'),
|
||||
print = require('gulp-print'),
|
||||
rename = require('gulp-rename'),
|
||||
replace = require('gulp-replace'),
|
||||
uglify = require('gulp-uglify'),
|
||||
|
||||
// user config
|
||||
config = require('../config/docs'),
|
||||
|
||||
// install config
|
||||
tasks = require('../config/tasks'),
|
||||
configSetup = require('../config/project/config'),
|
||||
install = require('../config/project/install'),
|
||||
|
||||
// metadata parsing
|
||||
metadata = require('./metadata'),
|
||||
|
||||
// shorthand
|
||||
globs,
|
||||
assets,
|
||||
output,
|
||||
source,
|
||||
|
||||
banner = tasks.banner,
|
||||
comments = tasks.regExp.comments,
|
||||
log = tasks.log,
|
||||
settings = tasks.settings
|
||||
;
|
||||
|
||||
// add internal tasks (concat release)
|
||||
require('../collections/internal')(gulp);
|
||||
|
||||
module.exports = function(callback) {
|
||||
|
||||
var
|
||||
stream,
|
||||
compressedStream,
|
||||
uncompressedStream
|
||||
;
|
||||
|
||||
// use a different config
|
||||
config = configSetup.addDerivedValues(config);
|
||||
|
||||
// shorthand
|
||||
globs = config.globs;
|
||||
assets = config.paths.assets;
|
||||
output = config.paths.output;
|
||||
source = config.paths.source;
|
||||
|
||||
/*--------------
|
||||
Parse metadata
|
||||
---------------*/
|
||||
|
||||
// parse all *.html.eco in docs repo, data will end up in
|
||||
// metadata.result object. Note this assumes that the docs
|
||||
// repository is present and in proper directory location as
|
||||
// specified by docs.json.
|
||||
console.info('Building Metadata');
|
||||
gulp.src(config.paths.template.eco + globs.eco)
|
||||
.pipe(map(metadata.parser))
|
||||
.on('end', function() {
|
||||
fs.writeFile(output.metadata + '/metadata.json', JSON.stringify(metadata.result, null, 2));
|
||||
})
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Copy Examples
|
||||
---------------*/
|
||||
|
||||
console.info('Copying examples');
|
||||
// copy src/ to server
|
||||
gulp.src('examples/**/*.*')
|
||||
.pipe(gulp.dest(output.examples))
|
||||
.pipe(print(log.created))
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Copy Source
|
||||
---------------*/
|
||||
|
||||
console.info('Copying LESS source');
|
||||
// copy src/ to server
|
||||
gulp.src('src/**/*.*')
|
||||
.pipe(gulp.dest(output.less))
|
||||
.pipe(print(log.created))
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Build
|
||||
---------------*/
|
||||
|
||||
console.info('Building Semantic for docs');
|
||||
|
||||
if( !install.isSetup() ) {
|
||||
console.error('Cannot build files. Run "gulp install" to set-up Semantic');
|
||||
return;
|
||||
}
|
||||
|
||||
// unified css stream
|
||||
stream = gulp.src(source.definitions + '/**/' + globs.components + '.less')
|
||||
.pipe(plumber())
|
||||
.pipe(less(settings.less))
|
||||
.pipe(autoprefixer(settings.prefix))
|
||||
.pipe(flatten())
|
||||
;
|
||||
|
||||
// two concurrent streams from same source to concat release
|
||||
uncompressedStream = stream.pipe(clone());
|
||||
compressedStream = stream.pipe(clone());
|
||||
|
||||
uncompressedStream
|
||||
.pipe(plumber())
|
||||
.pipe(replace(comments.variables.in, comments.variables.out))
|
||||
.pipe(replace(comments.large.in, comments.large.out))
|
||||
.pipe(replace(comments.small.in, comments.small.out))
|
||||
.pipe(replace(comments.tiny.in, comments.tiny.out))
|
||||
.pipe(replace(assets.source, assets.uncompressed))
|
||||
.pipe(header(banner, settings.header))
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
.pipe(gulp.dest(output.uncompressed))
|
||||
.pipe(print(log.created))
|
||||
.on('end', function() {
|
||||
gulp.start('package uncompressed docs css');
|
||||
})
|
||||
;
|
||||
|
||||
compressedStream = stream
|
||||
.pipe(plumber())
|
||||
.pipe(clone())
|
||||
.pipe(replace(assets.source, assets.compressed))
|
||||
.pipe(minifyCSS(settings.minify))
|
||||
.pipe(rename(settings.rename.minCSS))
|
||||
.pipe(header(banner, settings.header))
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
.pipe(gulp.dest(output.compressed))
|
||||
.pipe(print(log.created))
|
||||
.on('end', function() {
|
||||
callback();
|
||||
gulp.start('package compressed docs css');
|
||||
})
|
||||
;
|
||||
|
||||
// copy assets
|
||||
gulp.src(source.themes + '/**/assets/**/' + globs.components + '?(s).*')
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
.pipe(gulp.dest(output.themes))
|
||||
;
|
||||
|
||||
// copy source javascript
|
||||
gulp.src(source.definitions + '/**/' + globs.components + '.js')
|
||||
.pipe(plumber())
|
||||
.pipe(flatten())
|
||||
.pipe(gulp.dest(output.uncompressed))
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
.pipe(print(log.created))
|
||||
.pipe(uglify(settings.uglify))
|
||||
.pipe(rename(settings.rename.minJS))
|
||||
.pipe(header(banner, settings.header))
|
||||
.pipe(gulp.dest(output.compressed))
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
.pipe(print(log.created))
|
||||
.on('end', function() {
|
||||
gulp.start('package compressed docs js');
|
||||
gulp.start('package uncompressed docs js');
|
||||
})
|
||||
;
|
||||
|
||||
};
|
||||
138
semantic/tasks/docs/metadata.js
Normal file
138
semantic/tasks/docs/metadata.js
Normal file
@@ -0,0 +1,138 @@
|
||||
|
||||
/*******************************
|
||||
Summarize Docs
|
||||
*******************************/
|
||||
|
||||
var
|
||||
// node dependencies
|
||||
console = require('better-console'),
|
||||
fs = require('fs'),
|
||||
YAML = require('yamljs')
|
||||
;
|
||||
|
||||
var data = {};
|
||||
|
||||
/**
|
||||
* Test for prefix in string.
|
||||
* @param {string} str
|
||||
* @param {string} prefix
|
||||
* @return {boolean}
|
||||
*/
|
||||
function startsWith(str, prefix) {
|
||||
return str.indexOf(prefix) === 0;
|
||||
};
|
||||
|
||||
function inArray(needle, haystack) {
|
||||
var length = haystack.length;
|
||||
for(var i = 0; i < length; i++) {
|
||||
if(haystack[i] == needle) return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses a file for metadata and stores result in data object.
|
||||
* @param {File} file - object provided by map-stream.
|
||||
* @param {function(?,File)} - callback provided by map-stream to
|
||||
* reply when done.
|
||||
*/
|
||||
function parser(file, callback) {
|
||||
// file exit conditions
|
||||
if(file.isNull()) {
|
||||
return callback(null, file); // pass along
|
||||
}
|
||||
|
||||
if(file.isStream()) {
|
||||
return callback(new Error('Streaming not supported'));
|
||||
}
|
||||
|
||||
try {
|
||||
|
||||
var
|
||||
/** @type {string} */
|
||||
text = String(file.contents.toString('utf8')),
|
||||
lines = text.split('\n'),
|
||||
filename = file.path.substring(0, file.path.length - 4),
|
||||
key = 'server/documents',
|
||||
position = filename.indexOf(key)
|
||||
;
|
||||
|
||||
// exit conditions
|
||||
if(!lines) {
|
||||
return;
|
||||
}
|
||||
if(position < 0) {
|
||||
return callback(null, file);
|
||||
}
|
||||
|
||||
filename = filename.substring(position + key.length + 1, filename.length);
|
||||
|
||||
var
|
||||
lineCount = lines.length,
|
||||
active = false,
|
||||
yaml = [],
|
||||
categories = [
|
||||
'UI Element',
|
||||
'UI Global',
|
||||
'UI Collection',
|
||||
'UI View',
|
||||
'UI Module',
|
||||
'UI Behavior'
|
||||
],
|
||||
index,
|
||||
meta,
|
||||
line
|
||||
;
|
||||
|
||||
for(index = 0; index < lineCount; index++) {
|
||||
|
||||
line = lines[index];
|
||||
|
||||
// Wait for metadata block to begin
|
||||
if(!active) {
|
||||
if(startsWith(line, '---')) {
|
||||
active = true;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
// End of metadata block, stop parsing.
|
||||
if(startsWith(line, '---')) {
|
||||
break;
|
||||
}
|
||||
yaml.push(line);
|
||||
}
|
||||
|
||||
|
||||
// Parse yaml.
|
||||
meta = YAML.parse(yaml.join('\n'));
|
||||
if(meta && meta.type && meta.title && inArray(meta.type, categories) ) {
|
||||
meta.category = meta.type;
|
||||
meta.filename = filename;
|
||||
meta.url = '/' + filename;
|
||||
meta.title = meta.title;
|
||||
// Primary key will by filepath
|
||||
data[meta.element] = meta;
|
||||
}
|
||||
else {
|
||||
// skip
|
||||
// console.log(meta);
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
catch(error) {
|
||||
console.log(error, filename);
|
||||
}
|
||||
|
||||
callback(null, file);
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Export function expected by map-stream.
|
||||
*/
|
||||
module.exports = {
|
||||
result : data,
|
||||
parser : parser
|
||||
};
|
||||
255
semantic/tasks/docs/serve.js
Normal file
255
semantic/tasks/docs/serve.js
Normal file
@@ -0,0 +1,255 @@
|
||||
/*******************************
|
||||
Serve Docs
|
||||
*******************************/
|
||||
var
|
||||
gulp = require('gulp'),
|
||||
|
||||
// node dependencies
|
||||
console = require('better-console'),
|
||||
fs = require('fs'),
|
||||
|
||||
// gulp dependencies
|
||||
autoprefixer = require('gulp-autoprefixer'),
|
||||
chmod = require('gulp-chmod'),
|
||||
clone = require('gulp-clone'),
|
||||
gulpif = require('gulp-if'),
|
||||
header = require('gulp-header'),
|
||||
less = require('gulp-less'),
|
||||
minifyCSS = require('gulp-clean-css'),
|
||||
plumber = require('gulp-plumber'),
|
||||
print = require('gulp-print'),
|
||||
rename = require('gulp-rename'),
|
||||
replace = require('gulp-replace'),
|
||||
uglify = require('gulp-uglify'),
|
||||
util = require('gulp-util'),
|
||||
watch = require('gulp-watch'),
|
||||
|
||||
// user config
|
||||
config = require('../config/docs'),
|
||||
|
||||
// task config
|
||||
tasks = require('../config/tasks'),
|
||||
configSetup = require('../config/project/config'),
|
||||
install = require('../config/project/install'),
|
||||
|
||||
// shorthand
|
||||
banner = tasks.banner,
|
||||
comments = tasks.regExp.comments,
|
||||
log = tasks.log,
|
||||
settings = tasks.settings,
|
||||
|
||||
globs,
|
||||
assets,
|
||||
output,
|
||||
source
|
||||
;
|
||||
|
||||
require('../collections/internal')(gulp);
|
||||
|
||||
module.exports = function () {
|
||||
|
||||
// use a different config
|
||||
config = configSetup.addDerivedValues(config);
|
||||
|
||||
// shorthand
|
||||
globs = config.globs;
|
||||
assets = config.paths.assets;
|
||||
output = config.paths.output;
|
||||
source = config.paths.source;
|
||||
|
||||
|
||||
/*--------------
|
||||
Copy Source
|
||||
---------------*/
|
||||
|
||||
gulp
|
||||
.watch([
|
||||
'src/**/*.*'
|
||||
], function(file) {
|
||||
console.clear();
|
||||
return gulp.src(file.path, {
|
||||
base: 'src/'
|
||||
})
|
||||
.pipe(gulp.dest(output.less))
|
||||
.pipe(print(log.created))
|
||||
;
|
||||
})
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Copy Examples
|
||||
---------------*/
|
||||
|
||||
gulp
|
||||
.watch([
|
||||
'examples/**/*.*'
|
||||
], function(file) {
|
||||
console.clear();
|
||||
return gulp.src(file.path, {
|
||||
base: 'examples/'
|
||||
})
|
||||
.pipe(gulp.dest(output.examples))
|
||||
.pipe(print(log.created))
|
||||
;
|
||||
})
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Watch CSS
|
||||
---------------*/
|
||||
|
||||
gulp
|
||||
.watch([
|
||||
source.config,
|
||||
source.definitions + '/**/*.less',
|
||||
source.site + '/**/*.{overrides,variables}',
|
||||
source.themes + '/**/*.{overrides,variables}'
|
||||
], function(file) {
|
||||
|
||||
var
|
||||
lessPath,
|
||||
|
||||
stream,
|
||||
compressedStream,
|
||||
uncompressedStream,
|
||||
|
||||
isDefinition,
|
||||
isPackagedTheme,
|
||||
isSiteTheme,
|
||||
isConfig
|
||||
;
|
||||
|
||||
// log modified file
|
||||
gulp.src(file.path)
|
||||
.pipe(print(log.modified))
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Find Source
|
||||
---------------*/
|
||||
|
||||
// recompile on *.override , *.variable change
|
||||
isConfig = (file.path.indexOf('theme.config') !== -1 || file.path.indexOf('site.variables') !== -1);
|
||||
isPackagedTheme = (file.path.indexOf(source.themes) !== -1);
|
||||
isSiteTheme = (file.path.indexOf(source.site) !== -1);
|
||||
isDefinition = (file.path.indexOf(source.definitions) !== -1);
|
||||
|
||||
if(isConfig) {
|
||||
// console.info('Rebuilding all files');
|
||||
// cant rebuild paths are wrong
|
||||
// gulp.start('build-docs');
|
||||
return;
|
||||
}
|
||||
else if(isPackagedTheme) {
|
||||
console.log('Change detected in packaged theme');
|
||||
lessPath = util.replaceExtension(file.path, '.less');
|
||||
lessPath = lessPath.replace(tasks.regExp.theme, source.definitions);
|
||||
}
|
||||
else if(isSiteTheme) {
|
||||
console.log('Change detected in site theme');
|
||||
lessPath = util.replaceExtension(file.path, '.less');
|
||||
lessPath = lessPath.replace(source.site, source.definitions);
|
||||
}
|
||||
else {
|
||||
console.log('Change detected in definition');
|
||||
lessPath = file.path;
|
||||
}
|
||||
|
||||
/*--------------
|
||||
Create CSS
|
||||
---------------*/
|
||||
|
||||
if( fs.existsSync(lessPath) ) {
|
||||
|
||||
// unified css stream
|
||||
stream = gulp.src(lessPath)
|
||||
.pipe(plumber())
|
||||
.pipe(less(settings.less))
|
||||
.pipe(replace(comments.variables.in, comments.variables.out))
|
||||
.pipe(replace(comments.large.in, comments.large.out))
|
||||
.pipe(replace(comments.small.in, comments.small.out))
|
||||
.pipe(replace(comments.tiny.in, comments.tiny.out))
|
||||
.pipe(autoprefixer(settings.prefix))
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
;
|
||||
|
||||
// use 2 concurrent streams from same pipe
|
||||
uncompressedStream = stream.pipe(clone());
|
||||
compressedStream = stream.pipe(clone());
|
||||
|
||||
uncompressedStream
|
||||
.pipe(plumber())
|
||||
.pipe(replace(assets.source, assets.uncompressed))
|
||||
.pipe(header(banner, settings.header))
|
||||
.pipe(gulp.dest(output.uncompressed))
|
||||
.pipe(print(log.created))
|
||||
.on('end', function() {
|
||||
gulp.start('package uncompressed docs css');
|
||||
})
|
||||
;
|
||||
|
||||
compressedStream = stream
|
||||
.pipe(plumber())
|
||||
.pipe(replace(assets.source, assets.compressed))
|
||||
.pipe(minifyCSS(settings.minify))
|
||||
.pipe(rename(settings.rename.minCSS))
|
||||
.pipe(header(banner, settings.header))
|
||||
.pipe(gulp.dest(output.compressed))
|
||||
.pipe(print(log.created))
|
||||
.on('end', function() {
|
||||
gulp.start('package compressed docs css');
|
||||
})
|
||||
;
|
||||
|
||||
}
|
||||
else {
|
||||
console.log('Cannot find UI definition at path', lessPath);
|
||||
}
|
||||
})
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Watch JS
|
||||
---------------*/
|
||||
|
||||
gulp
|
||||
.watch([
|
||||
source.definitions + '/**/*.js'
|
||||
], function(file) {
|
||||
gulp.src(file.path)
|
||||
.pipe(plumber())
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
.pipe(gulp.dest(output.uncompressed))
|
||||
.pipe(print(log.created))
|
||||
.pipe(uglify(settings.uglify))
|
||||
.pipe(rename(settings.rename.minJS))
|
||||
.pipe(gulp.dest(output.compressed))
|
||||
.pipe(print(log.created))
|
||||
.on('end', function() {
|
||||
gulp.start('package compressed docs js');
|
||||
gulp.start('package uncompressed docs js');
|
||||
})
|
||||
;
|
||||
})
|
||||
;
|
||||
|
||||
/*--------------
|
||||
Watch Assets
|
||||
---------------*/
|
||||
|
||||
// only copy assets that match component names (or their plural)
|
||||
gulp
|
||||
.watch([
|
||||
source.themes + '/**/assets/**/' + globs.components + '?(s).*'
|
||||
], function(file) {
|
||||
// copy assets
|
||||
gulp.src(file.path, { base: source.themes })
|
||||
.pipe(gulpif(config.hasPermission, chmod(config.permission)))
|
||||
.pipe(gulp.dest(output.themes))
|
||||
.pipe(print(log.created))
|
||||
;
|
||||
})
|
||||
;
|
||||
|
||||
|
||||
};
|
||||
Reference in New Issue
Block a user