sparkles: Changes for new freesewing plugin model
This commit is contained in:
Joost De Cock
parent
f431e845c3
commit
0f6cfa62b9
3 changed files with 976 additions and 898 deletions
1540
packages/plugin-validate/package-lock.json
generated
1540
packages/plugin-validate/package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
|
@ -1,149 +1,57 @@
|
||||||
import { version, name } from "../package.json";
|
import { version, name } from "../package.json";
|
||||||
|
import validate from "./validate";
|
||||||
const dbg = {
|
|
||||||
debug: 'custom',
|
|
||||||
text: 'Validation error',
|
|
||||||
style: 'color: red; font-weight: bold;'
|
|
||||||
}
|
|
||||||
|
|
||||||
function validatePoint(point, partId, pointId, debug) {
|
|
||||||
if(typeof point !== 'object') {
|
|
||||||
debug(dbg, 'Problem with point:', point);
|
|
||||||
throw(`Point pattern.parts.${partId}.points.${pointId} is not an object`);
|
|
||||||
} else if(typeof point.x !== 'number' || isNaN(point.x)) {
|
|
||||||
debug(dbg, 'Problem with point X-value:', point);
|
|
||||||
throw(`X-value of point pattern.parts.${partId}.points.${pointId} is not a number`);
|
|
||||||
} else if(typeof point.y !== 'number' || isNaN(point.y)) {
|
|
||||||
debug(dbg, 'Problem with point Y-value:', point);
|
|
||||||
throw(`Y-value of point pattern.parts.${partId}.points.${pointId} is not a number`);
|
|
||||||
} else if(typeof point.attributes !== 'object' || !point.attributes.clone instanceof Function) {
|
|
||||||
debug(dbg, 'Problem with point attributes:', point);
|
|
||||||
throw(dbg, `attributes property of point pattern.parts.${partId}.points.${pointId} is not an object`);
|
|
||||||
} else if(!point.clone instanceof Function) {
|
|
||||||
debug(dbg, 'Problem with point:', point);
|
|
||||||
throw(`Point pattern.parts.${partId}.points.${pointId} is not a valid Point object`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
function validateText(type, item, partId, itemId, debug) {
|
|
||||||
let text = item.attributes.getAsArray('data-text');
|
|
||||||
if(text === false) return true;
|
|
||||||
else {
|
|
||||||
if(item.attributes.get('data-validate-skip-text') !== false) {
|
|
||||||
debug(
|
|
||||||
{
|
|
||||||
debug: 'custom',
|
|
||||||
text: 'Validation warning',
|
|
||||||
style: 'color: #da0; font-weight: bold;'
|
|
||||||
},
|
|
||||||
'This text might be a translation problem:',
|
|
||||||
item,
|
|
||||||
'However, the error was suppresed, so moving on.'
|
|
||||||
);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
for (let t of text) {
|
|
||||||
if(typeof t !== 'string' && typeof t !== 'number') {
|
|
||||||
debug(dbg, 'This text is not a string or number:', t);
|
|
||||||
throw(`${type} pattern.parts.${partId}.${type}s.${itemId} has text that is not a string nor a number. Set the 'data-validate-skip-text' attribute to true to suppress this error.`);
|
|
||||||
|
|
||||||
} else if(typeof t === 'string' && t.indexOf(' ') !== -1) {
|
|
||||||
debug(dbg, 'This text might be a translation problem:', item);
|
|
||||||
throw(`${type} pattern.parts.${partId}.${type}s.${itemId} has text containing spaces. Please insert translation identifiers, and not actual text. Set the 'data-validate-skip-text' attribute to true to suppress this error.`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
function validatePath(path, partId, pathId, debug) {
|
|
||||||
if(typeof path !== 'object') {
|
|
||||||
debug(dbg, 'Problem with path:', path);
|
|
||||||
throw(`Path pattern.parts.${partId}.paths.${pathId} is not an object`);
|
|
||||||
} else if(typeof path.ops !== 'object') {
|
|
||||||
debug(dbg, 'Problem with path ops:', path);
|
|
||||||
throw(`ops property of path pattern.parts.${partId}.paths.${pathId} is not an object`);
|
|
||||||
} else if(path.ops.length < 2) {
|
|
||||||
debug(dbg, 'Problem with path ops:', path);
|
|
||||||
throw(`Path pattern.parts.${partId}.paths.${pathId} does not do anything`);
|
|
||||||
} else if(typeof path.attributes !== 'object') {
|
|
||||||
debug(dbg, 'Problem with path attributes:', path);
|
|
||||||
throw(`attributes property of path pattern.parts.${partId}.paths.${pathId} is not an object`);
|
|
||||||
} else if(!path.clone instanceof Function) {
|
|
||||||
debug(dbg, 'Problem with path:', path);
|
|
||||||
throw(`Path pattern.parts.${partId}.paths.${pathId} is not a valid Path object`);
|
|
||||||
} else if(!path.attributes.clone instanceof Function) {
|
|
||||||
debug(dbg, 'Problem with path attributes:', path);
|
|
||||||
throw(`attributes property of path pattern.parts.${partId}.paths.${pathId} is not a valid Attributes object`);
|
|
||||||
}
|
|
||||||
for (let o in path.ops) {
|
|
||||||
let op = path.ops[o];
|
|
||||||
if(op.type !== 'close') {
|
|
||||||
if(!validatePoint(op.to, partId, '_unknown_', debug)) {
|
|
||||||
debug(dbg, 'Problem with path TO point:', op.to);
|
|
||||||
throw(`Point in pattern.parts.${partId}.paths.${pathId}.ops[o].to is not a valid Point object`);
|
|
||||||
}
|
|
||||||
} else if (op.type === 'curve') {
|
|
||||||
if(!validatePoint(op.cp1, partId, '_unknown_', debug)) {
|
|
||||||
debug(dbg, 'Problem with path CP1 point:', op.cp1);
|
|
||||||
throw(`Point in pattern.parts.${partId}.paths.${pathId}.ops[o].cp1 is not a valid Point object`);
|
|
||||||
} else if(!validatePoint(op.cp2, partId, '_unknown_', debug)) {
|
|
||||||
debug(dbg, 'Problem with path CP2 point:', op.cp1);
|
|
||||||
throw(`Point in pattern.parts.${partId}.paths.${pathId}.ops[o].cp2 is not a valid Point object`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
function isSnippet(snippet, partId, snippetId, debug) {
|
|
||||||
if(typeof snippet !== 'object') return false;
|
|
||||||
if(!validatePoint(snippet.anchor, partId, '_unknown_', debug)) return false;
|
|
||||||
if(typeof snippet.attributes !== 'object') return false;
|
|
||||||
if(!snippet.clone instanceof Function) return false;
|
|
||||||
if(!snippet.attributes.clone instanceof Function) return false;
|
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default {
|
export default {
|
||||||
name: name,
|
name: name,
|
||||||
version: version,
|
version: version,
|
||||||
hooks: {
|
hooks: {
|
||||||
preDraft: function(next) {
|
preDraft: function(pattern) {
|
||||||
for(let m in this.config.measurements) {
|
if(typeof pattern.settings.measurements === "undefined")
|
||||||
let measurement = this.config.measurements[m];
|
return pattern.debug({
|
||||||
if(!this.context.settings.measurements[measurement]) {
|
type: "error",
|
||||||
this.debug(dbg, 'Missing measurement:', measurement);
|
label: '👕 No measurements provided',
|
||||||
this.debug('All measurements:', this.settings.measurements);
|
msg: "You did not provide any measurements. Most, if not all, patterns require measurements, so this is most likely an issue."
|
||||||
throw `Missing measurement: ${measurement}`;
|
});
|
||||||
|
for(let measurement of pattern.config.measurements) {
|
||||||
|
if(!pattern.settings.measurements[measurement]) {
|
||||||
|
pattern.debug({
|
||||||
|
type: "error",
|
||||||
|
label: '👕 Missing measurement:',
|
||||||
|
msg: measurement
|
||||||
|
});
|
||||||
|
pattern.debug({
|
||||||
|
type: "info",
|
||||||
|
label: '👕 All measurements:',
|
||||||
|
msg: pattern.settings.measurements
|
||||||
|
});
|
||||||
|
throw new Error(`Missing measurement: ${measurement}`);
|
||||||
|
} else {
|
||||||
|
this.debug({
|
||||||
|
type: "success",
|
||||||
|
label: '👕 '+measurement+' is ok',
|
||||||
|
msg: pattern.settings.measurements[measurement]
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
next();
|
|
||||||
},
|
},
|
||||||
postDraft: function(next) {
|
postDraft: function(pattern) {
|
||||||
for(let partId in this.parts) {
|
for(let partId in pattern.parts) {
|
||||||
let part = this.parts[partId];
|
let part = pattern.parts[partId];
|
||||||
let { debug } = part.shorthand();
|
let { debug } = part.shorthand();
|
||||||
for(let pointId in part.points) {
|
for(let pointId in part.points) {
|
||||||
validatePoint(part.points[pointId], partId, pointId, debug);
|
validate.point(part.points[pointId], partId, pointId, debug);
|
||||||
validateText('point', part.points[pointId], partId, pointId, debug);
|
validate.text('point', part.points[pointId], partId, pointId, debug);
|
||||||
}
|
}
|
||||||
for(let pathId in part.paths) {
|
for(let pathId in part.paths) {
|
||||||
validatePath(part.paths[pathId], partId, pathId, debug);
|
validate.path(part.paths[pathId], partId, pathId, debug);
|
||||||
validateText('path', part.paths[pathId], partId, pathId, debug);
|
validate.text('path', part.paths[pathId], partId, pathId, debug);
|
||||||
}
|
}
|
||||||
for(let snippetId in part.snippets) {
|
for(let snippetId in part.snippets) {
|
||||||
if(!isSnippet(part.snippets[snippetId], partId, snippetId, debug)) {
|
if(!validate.snippet(part.snippets[snippetId], partId, snippetId, debug)) {
|
||||||
throw(`pattern.parts.${partId}.snippets.${snippetId} is not a valid Snippet object`);
|
throw new Error(`pattern.parts.${partId}.snippets.${snippetId} is not a valid Snippet object`);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
next();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
|
||||||
170
packages/plugin-validate/src/validate.js
Normal file
170
packages/plugin-validate/src/validate.js
Normal file
|
|
@ -0,0 +1,170 @@
|
||||||
|
const validate = {};
|
||||||
|
|
||||||
|
validate.point = function (point, partId, pointId, debug) {
|
||||||
|
if(typeof point !== 'object') {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with point',
|
||||||
|
msg: points
|
||||||
|
});
|
||||||
|
throw new Error(`Point pattern.parts.${partId}.points.${pointId} is not an object`);
|
||||||
|
} else if(typeof point.x !== 'number' || isNaN(point.x)) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with point X-value',
|
||||||
|
msg: points
|
||||||
|
});
|
||||||
|
throw new Error(`X-value of point pattern.parts.${partId}.points.${pointId} is not a number`);
|
||||||
|
} else if(typeof point.y !== 'number' || isNaN(point.y)) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with point Y-value',
|
||||||
|
msg: points
|
||||||
|
});
|
||||||
|
debug(dbg, 'Problem with point Y-value:', point);
|
||||||
|
throw new Error(`Y-value of point pattern.parts.${partId}.points.${pointId} is not a number`);
|
||||||
|
} else if(typeof point.attributes !== 'object' || !point.attributes.clone instanceof Function) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with point attributes',
|
||||||
|
msg: points
|
||||||
|
});
|
||||||
|
throw new Error (dbg, `attributes property of point pattern.parts.${partId}.points.${pointId} is not an object`);
|
||||||
|
} else if(!point.clone instanceof Function) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with point',
|
||||||
|
msg: points
|
||||||
|
});
|
||||||
|
throw new Error(`Point pattern.parts.${partId}.points.${pointId} is not a valid Point object`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
validate.text = function (type, item, partId, itemId, debug) {
|
||||||
|
let text = item.attributes.getAsArray('data-text');
|
||||||
|
if(text === false) return true;
|
||||||
|
else {
|
||||||
|
if(item.attributes.get('data-validate-skip-text') !== false) {
|
||||||
|
debug({
|
||||||
|
type: "warning",
|
||||||
|
label: '🌐 Possible translation issue',
|
||||||
|
msg: `This text might be a translation problem:, ${item} However, the error was suppresed, so moving on.`
|
||||||
|
});
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
for (let t of text) {
|
||||||
|
if(typeof t !== 'string' && typeof t !== 'number') {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'This text is not a string or number',
|
||||||
|
msg: t
|
||||||
|
});
|
||||||
|
throw new Error(`${type} pattern.parts.${partId}.${type}s.${itemId} has text that is not a string nor a number. Set the 'data-validate-skip-text' attribute to true to suppress this error.`);
|
||||||
|
|
||||||
|
} else if(typeof t === 'string' && t.indexOf(' ') !== -1) {
|
||||||
|
debug({
|
||||||
|
type: "warning",
|
||||||
|
label: '🌐 Possible translation issue',
|
||||||
|
msg: t
|
||||||
|
});
|
||||||
|
debug({
|
||||||
|
type: "info",
|
||||||
|
label: "💡 Tip",
|
||||||
|
msg: `${type} pattern.parts.${partId}.${type}s.${itemId} has text containing spaces. Please insert translation identifiers, and not actual text. Set the 'data-validate-skip-text' attribute to true to suppress this warning.`
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
validate.path = function(path, partId, pathId, debug) {
|
||||||
|
if(typeof path !== 'object') {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path',
|
||||||
|
msg: path
|
||||||
|
});
|
||||||
|
throw new Error(`Path pattern.parts.${partId}.paths.${pathId} is not an object`);
|
||||||
|
} else if(typeof path.ops !== 'object') {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path ops',
|
||||||
|
msg: path
|
||||||
|
});
|
||||||
|
throw new Error(`ops property of path pattern.parts.${partId}.paths.${pathId} is not an object`);
|
||||||
|
} else if(path.ops.length < 2) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path ops',
|
||||||
|
msg: path
|
||||||
|
});
|
||||||
|
throw new Error(`Path pattern.parts.${partId}.paths.${pathId} does not do anything`);
|
||||||
|
} else if(typeof path.attributes !== 'object') {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path attributes',
|
||||||
|
msg: path
|
||||||
|
});
|
||||||
|
throw new Error(`attributes property of path pattern.parts.${partId}.paths.${pathId} is not an object`);
|
||||||
|
} else if(!path.clone instanceof Function) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path',
|
||||||
|
msg: path
|
||||||
|
});
|
||||||
|
throw new Error(`Path pattern.parts.${partId}.paths.${pathId} is not a valid Path object`);
|
||||||
|
} else if(!path.attributes.clone instanceof Function) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path attributes',
|
||||||
|
msg: path
|
||||||
|
});
|
||||||
|
throw new Error(`attributes property of path pattern.parts.${partId}.paths.${pathId} is not a valid Attributes object`);
|
||||||
|
}
|
||||||
|
for (let o in path.ops) {
|
||||||
|
let op = path.ops[o];
|
||||||
|
if(op.type !== 'close') {
|
||||||
|
if(!validate.point(op.to, partId, '_unknown_', debug)) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path TO point',
|
||||||
|
msg: op.to
|
||||||
|
});
|
||||||
|
throw new Error(`Point in pattern.parts.${partId}.paths.${pathId}.ops[o].to is not a valid Point object`);
|
||||||
|
}
|
||||||
|
} else if (op.type === 'curve') {
|
||||||
|
if(!validate.point(op.cp1, partId, '_unknown_', debug)) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path CP1 point',
|
||||||
|
msg: op.cp1
|
||||||
|
});
|
||||||
|
throw new Error(`Point in pattern.parts.${partId}.paths.${pathId}.ops[o].cp1 is not a valid Point object`);
|
||||||
|
} else if(!validate.point(op.cp2, partId, '_unknown_', debug)) {
|
||||||
|
debug({
|
||||||
|
type: "error",
|
||||||
|
label: 'Problem with path CP2 point',
|
||||||
|
msg: op.cp2
|
||||||
|
});
|
||||||
|
throw new Error(`Point in pattern.parts.${partId}.paths.${pathId}.ops[o].cp2 is not a valid Point object`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
validate.snippet = function (snippet, partId, snippetId, debug) {
|
||||||
|
if(typeof snippet !== 'object') return false;
|
||||||
|
if(!validate.point(snippet.anchor, partId, '_unknown_', debug)) return false;
|
||||||
|
if(typeof snippet.attributes !== 'object') return false;
|
||||||
|
if(!snippet.clone instanceof Function) return false;
|
||||||
|
if(!snippet.attributes.clone instanceof Function) return false;
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
export default validate;
|
||||||
Loading…
Add table
Add a link
Reference in a new issue