Upload a zip to check for errors, deprecations and other compatibility issues.
-GScan validates your theme based on the Ghost 1.0 requirements.
- - See the changelog for Ghost 1.0 themes +GScan validates your theme based on the Ghost 2.0 requirements by default.
+You can select a different version if you need to check your theme for a previous major version.
+ + + See the changelog for Ghost 2.0 themes{{pageUrl}} with {{page_url}}',
fatal: true,
details: 'The helper {{pageUrl}} was replaced with {{page_url}}.{{page_url}} helper here.'
+ 'Find more information about the {{page_url}} helper here.',
+ regex: /{{\s*?pageUrl\b[\w\s='"]*?}}/ig,
+ helper: '{{pageUrl}}'
},
'GS001-DEPR-MD': {
level: 'error',
rule: 'The usage of {{meta_description}} in HTML head is no longer required',
details: 'The usage of {{meta_description}} in the HTML head tag is no longer required because Ghost outputs this for you automatically in {{ghost_head}}.{{meta_description}} here.{{ghost_head}} helper, look here.'
+ 'Check out the documentation for {{meta_description}} here.{{ghost_head}} helper, look here.',
+ regex: /{{image}} helper was replaced with the {{img_url}} helper.{{img_url}} helper you would need to use e. g. {{#post}}
{{img_url feature_image}}
{{/post}}{{if image}}, then you have to replace it with e.g. {{if feature_image}}.' +
- '{{img_url}} helper here and ' +
- 'read more about Ghost\'s usage of contexts here.'
+ '{{img_url}} helper here and ' +
+ 'read more about Ghost\'s usage of contexts here.',
+ regex: /{{\s*?image\b[\w\s='"]*?}}/g,
+ helper: '{{image}}'
},
'GS001-DEPR-COV': {
level: 'error',
@@ -105,8 +111,10 @@ rules = {
fatal: true,
details: 'The cover attribute was replaced with cover_image. To render the cover image in author context, you need to use{{#author}}
{{cover_image}}
{{/author}}author here.{{@blog.cover_image}}. See here.'
+ 'See the object attributes of author here.{{@blog.cover_image}}. See here.',
+ regex: /{{\s*?cover\s*?}}/g,
+ helper: '{{cover}}'
},
'GS001-DEPR-AIMG': {
level: 'error',
@@ -114,7 +122,9 @@ rules = {
fatal: true,
details: 'The image attribute in author context was replaced with profile_image.{{author.image}} you need to use {{author.profile_image}}.author here.'
+ 'See the object attributes of author here.',
+ regex: /{{\s*?author\.image\s*?}}/g,
+ helper: '{{author.image}}'
},
'GS001-DEPR-PIMG': {
level: 'error',
@@ -122,7 +132,9 @@ rules = {
fatal: true,
details: 'The image attribute in post context was replaced with feature_image.{{post.image}} you need to use {{post.feature_image}}.post here.'
+ 'See the object attributes of post here.',
+ regex: /{{\s*?post\.image\s*?}}/g,
+ helper: '{{post.image}}'
},
'GS001-DEPR-BC': {
level: 'error',
@@ -130,7 +142,9 @@ rules = {
fatal: true,
details: 'The cover attribute was replaced with cover_image.{{@blog.cover}} you need to use {{@blog.cover_image}}.cover attribute was replaced with cover_image.{{author.cover}} you need to use {{author.cover_image}}.author here.'
+ 'See the object attributes of author here.',
+ regex: /{{\s*?author\.cover\s*?}}/g,
+ helper: '{{author.cover}}'
},
'GS001-DEPR-TIMG': {
level: 'error',
@@ -146,7 +162,9 @@ rules = {
fatal: true,
details: 'The image attribute in tag context was replaced with feature_image.{{tag.image}} you need to use {{tag.feature_image}}.tags here.'
+ 'See the object attributes of tags here.',
+ regex: /{{\s*?tag\.image\s*?}}/g,
+ helper: '{{tag.image}}'
},
'GS001-DEPR-PAIMG': {
level: 'error',
@@ -154,7 +172,9 @@ rules = {
fatal: true,
details: 'The image attribute in author context was replaced with feature_image.{{post.author.image}} you need to use {{post.author.feature_image}}.author here.'
+ 'See the object attributes of author here.',
+ regex: /{{\s*?post\.author\.image\s*?}}/g,
+ helper: '{{post.author.image}}'
},
'GS001-DEPR-PAC': {
level: 'error',
@@ -162,7 +182,9 @@ rules = {
fatal: true,
details: 'The cover attribute in author context was replaced with cover_image.{{post.author.cover}} you need to use {{post.author.cover_image}}.author here.'
+ 'See the object attributes of author here.',
+ regex: /{{\s*?post\.author\.cover\s*?}}/g,
+ helper: '{{post.author.cover}}'
},
'GS001-DEPR-PTIMG': {
level: 'error',
@@ -170,7 +192,9 @@ rules = {
fatal: true,
details: 'The image attribute in tag context was replaced with feature_image.{{post.tags.[#].image}} you need to use {{post.tags.[#].feature_image}}.tags here.'
+ 'See the object attributes of tags here.',
+ regex: /{{\s*?post\.tags\.\[[0-9]+\]\.image\s*?}}/g,
+ helper: '{{post.tags.[#].image}}'
},
'GS001-DEPR-TSIMG': {
level: 'error',
@@ -178,7 +202,9 @@ rules = {
fatal: true,
details: 'The image attribute in tag context was replaced with feature_image.{{tags.[#].image}} you need to use {{tags.[#].feature_image}}.tags here.'
+ 'See the object attributes of tags here.',
+ regex: /{{\s*?tags\.\[[0-9]+\]\.image\s*?}}/g,
+ helper: '{{tags.[#].image}}'
},
'GS001-DEPR-CON-IMG': {
level: 'error',
@@ -198,7 +224,9 @@ rules = {
'{{#tag}}
' +
' {{#if feature_image}}
{{feature_image}}
{{/if}}
' +
'{{/tag}}tags here.'
+ 'See the object attributes of tags here.',
+ regex: /{{\s*?#if\s*?image\s*?}}/g,
+ helper: '{{#if image}}'
},
'GS001-DEPR-CON-COV': {
level: 'error',
@@ -206,8 +234,10 @@ rules = {
fatal: true,
details: 'The cover attribute was replaced with cover_image. To check for the cover image in author context, you need to use{{#if cover_image}}
{{cover_image}}
{{/if}}author here.{{#if @blog.cover_image}}. See here.'
+ 'See the object attributes of author here.{{#if @blog.cover_image}}. See here.',
+ regex: /{{\s*?#if\s*?cover\s*?}}/g,
+ helper: '{{#if cover}}'
},
'GS001-DEPR-CON-BC': {
level: 'error',
@@ -215,7 +245,9 @@ rules = {
fatal: true,
details: 'The cover attribute was replaced with cover_image.{{#if @blog.cover}} you need to use {{#if @blog.cover_image}}.cover attribute was replaced with cover_image.{{#if author.cover}} you need to use {{#if author.cover_image}}.author here.'
+ 'See the object attributes of author here.',
+ regex: /{{\s*?#if\s*?author\.cover\s*?}}/g,
+ helper: '{{#if author.cover}}'
},
'GS001-DEPR-CON-AIMG': {
level: 'error',
@@ -231,7 +265,9 @@ rules = {
fatal: true,
details: 'The image attribute in author context was replaced with profile_image.{{#if author.image}} you need to use {{#if author.profile_image}}.author here.'
+ 'See the object attributes of author here.',
+ regex: /{{\s*?#if\s*?author\.image\s*?}}/g,
+ helper: '{{#if author.image}}'
},
'GS001-DEPR-CON-TIMG': {
level: 'error',
@@ -239,7 +275,9 @@ rules = {
fatal: true,
details: 'The image attribute in tag context was replaced with feature_image.{{#if tag.image}} you need to use {{#if tag.feature_image}}.tags here.'
+ 'See the object attributes of tags here.',
+ regex: /{{\s*?#if\s*?tag\.image\s*?}}/g,
+ helper: '{{#if tag.image}}'
},
'GS001-DEPR-CON-PTIMG': {
level: 'error',
@@ -247,7 +285,9 @@ rules = {
fatal: true,
details: 'The image attribute in tag context was replaced with feature_image.{{#if post.tags.[#].image}} you need to use {{#if post.tags.[#].feature_image}}.tags here.'
+ 'See the object attributes of tags here.',
+ regex: /{{\s*?#if\s*?post\.tags\.\[[0-9]+\].image\s*?}}/g,
+ helper: '{{#if posts.tags.[#].image}}'
},
'GS001-DEPR-CON-TSIMG': {
level: 'error',
@@ -255,38 +295,53 @@ rules = {
fatal: true,
details: 'The image attribute in tag context was replaced with feature_image.{{#if tags.[#].image}} you need to use {{#if tags.[#].feature_image}}.tags here.'
+ 'See the object attributes of tags here.',
+ regex: /{{\s*?#if\s*?tags\.\[[0-9]+\].image\s*?}}/g,
+ helper: '{{#if tags.[#].image}}'
},
'GS001-DEPR-PPP': {
level: 'error',
rule: 'Replace {{@blog.posts_per_page}} with {{@config.posts_per_page}}',
details: 'The global {{@blog.posts_per_page}} property was replaced with {{@config.posts_per_page}}.{{content words="0"}} with the {{img_url}} helper',
details: 'The {{content words="0"}} hack doesn\'t work anymore (and was never supported). Please use the {{img_url}} helper to render images.{{img_url}} helper here and '
+ 'Find more information about the {{img_url}} helper here and ',
+ regex: /{{\s*?content words=("|')0("|')\s*?}}/g,
+ helper: '{{content words="0"}}'
},
'GS001-DEPR-CSS-AT': {
level: 'error',
rule: 'Replace .archive-template with the .paged CSS class',
details: 'The .archive-template CSS class was replaced with the .paged. Please replace this in your stylesheet..page with the .page-template css class',
details: 'The .page CSS class was replaced with the .page-template. Please replace this in your stylesheet..page-template-slug with the .page-slug css class',
details: 'The .page-template-slug CSS class was replaced with the .page-slug. Please replace this in your stylesheet.{{comment_id}} helper that will output the old ID ' +
'for posts that have been imported from LTS, and the new ID for new posts. ' +
'The Disqus embed must be updated from this.page.identifier = \'ghost-{{id}}\'; to ' +
- 'this.page.identifier = \'ghost-{{comment_id}}\'; to ensure Disqus continues to work.'
+ 'this.page.identifier = \'ghost-{{comment_id}}\'; to ensure Disqus continues to work.',
+ regex: /(page\.|disqus_)identifier\s?=\s?['"].*?({{\s*?id\s*?}}).*?['"];?/g
},
'GS002-ID-HELPER': {
level: 'recommendation',
+ version: 'v1',
rule: 'The output of {{id}} changed between Ghost LTS and 1.0.0, you may need to use {{comment_id}} instead.',
details:
'The output of {{id}} has changed between Ghost LTS and 1.0.0. ' +
@@ -308,7 +365,8 @@ rules = {
'We\'ve added a new {{comment_id}} helper that will output the old ID ' +
'for posts that have been imported from LTS, and the new ID for new posts. ' +
'If you need the old ID to be output on imported posts, then you will need to use ' +
- '{{comment_id}} rather than {{id}}.'
+ '{{comment_id}} rather than {{id}}.',
+ regex: /({{\s*?id\s*?}})/g
},
'GS005-TPL-ERR': {
level: 'error',
@@ -395,26 +453,30 @@ rules = {
rule: 'A template file called index.hbs must be present',
fatal: true,
details: 'Your theme must have a template file called index.hbs.index.hbs in particular.'
+ 'Read here more about the required template structure and index.hbs in particular.',
+ path: 'index.hbs'
},
'GS020-POST-REQ': {
level: 'error',
rule: 'A template file called post.hbs must be present',
fatal: true,
details: 'Your theme must have a template file called index.hbs.post.hbs in particular.'
+ 'Read here more about the required template structure and post.hbs in particular.',
+ path: 'post.hbs'
},
'GS020-DEF-REC': {
level: 'recommendation',
rule: 'Provide a default layout template called default.hbs',
details: 'It is recommended that your theme has a template file called default.hbs.default.hbs in particular.'
+ 'Read here more about the recommended template structure and default.hbs in particular.',
+ path: 'default.hbs'
},
'GS030-ASSET-REQ': {
level: 'warning',
rule: 'Assets such as CSS & JS must use the {{asset}} helper',
details: 'The listed files should be included using the {{asset}} helper.{{asset}} helper documentation.'
+ 'For more information, please see the {{asset}} helper documentation.',
+ regex: /(src|href)=['"](.*?\/assets\/.*?)['"]/gmi
},
'GS030-ASSET-SYM': {
level: 'error',
@@ -428,14 +490,16 @@ rules = {
rule: 'The helper {{ghost_head}} should be present',
details: 'The {{ghost_head}} helper should be present in your theme. It outputs many useful things, such as "code injection" scripts, structured data, canonical links, meta description etc.default.hbs template.{{ghost_head}} helper documentation.'
+ 'For more details, please see the {{ghost_head}} helper documentation.',
+ helper: 'ghost_head'
},
'GS040-GF-REQ': {
level: 'warning',
rule: 'The helper {{ghost_foot}} should be present',
details: 'The {{ghost_foot}} helper should be present in your theme. It outputs scripts as saved in "code injection" scripts.default.hbs template.{{ghost_foot}} helper documentation.'
+ 'For more details, please see the {{ghost_foot}} helper documentation.',
+ helper: 'ghost_foot'
}
};
diff --git a/test/001-deprecations.test.js b/test/001-deprecations.test.js
index 162d6b47f..fc77ad949 100644
--- a/test/001-deprecations.test.js
+++ b/test/001-deprecations.test.js
@@ -3,168 +3,342 @@ var should = require('should'), // eslint-disable-line no-unused-vars
utils = require('./utils');
describe('001 Deprecations', function () {
- it('[failure] theme is invalid', function (done) {
- utils.testCheck(thisCheck, '001-deprecations/invalid').then(function (output) {
- output.should.be.a.ValidThemeObject();
-
- output.results.fail.should.be.an.Object().with.keys(
- 'GS001-DEPR-PURL',
- 'GS001-DEPR-MD',
- 'GS001-DEPR-IMG',
- 'GS001-DEPR-COV',
- 'GS001-DEPR-AIMG',
- 'GS001-DEPR-PIMG',
- 'GS001-DEPR-PAIMG',
- 'GS001-DEPR-PAC',
- 'GS001-DEPR-PTIMG',
- 'GS001-DEPR-TSIMG',
- 'GS001-DEPR-PPP',
- 'GS001-DEPR-C0H',
- 'GS001-DEPR-BC',
- 'GS001-DEPR-CON-BC',
- 'GS001-DEPR-AC',
- 'GS001-DEPR-CON-AC',
- 'GS001-DEPR-CON-AIMG',
- 'GS001-DEPR-CON-PTIMG',
- 'GS001-DEPR-CON-TSIMG',
- 'GS001-DEPR-CON-IMG',
- 'GS001-DEPR-CON-COV',
- 'GS001-DEPR-CON-TIMG',
- 'GS001-DEPR-TIMG',
- 'GS001-DEPR-CSS-AT',
- 'GS001-DEPR-CSS-PA',
- 'GS001-DEPR-CSS-PATS'
- );
-
- // pageUrl
- output.results.fail['GS001-DEPR-PURL'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-PURL'].failures.length.should.eql(3);
-
- // meta_description in - output.results.fail['GS001-DEPR-MD'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-MD'].failures.length.should.eql(1);
-
- // {{image}}
- output.results.fail['GS001-DEPR-IMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-IMG'].failures.length.should.eql(2);
-
- // {{cover}}
- output.results.fail['GS001-DEPR-COV'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-COV'].failures.length.should.eql(3);
-
- // {{author.image}}
- output.results.fail['GS001-DEPR-AIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-AIMG'].failures.length.should.eql(2);
-
- // {{post.image}}
- output.results.fail['GS001-DEPR-PIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-PIMG'].failures.length.should.eql(1);
-
- // {{@blog.cover}}
- output.results.fail['GS001-DEPR-BC'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-BC'].failures.length.should.eql(1);
-
- // {{author.cover}}
- output.results.fail['GS001-DEPR-AC'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-AC'].failures.length.should.eql(2);
-
- // {{post.author.cover}}
- output.results.fail['GS001-DEPR-PAC'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-PAC'].failures.length.should.eql(1);
-
- // {{post.author.image}}
- output.results.fail['GS001-DEPR-PAIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-PAIMG'].failures.length.should.eql(1);
-
- // {{tag.image}}
- output.results.fail['GS001-DEPR-TIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-TIMG'].failures.length.should.eql(1);
-
- // {{posts.tags.[4].image}}
- output.results.fail['GS001-DEPR-PTIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-PTIMG'].failures.length.should.eql(1);
-
- // {{tags.[4].image}}
- output.results.fail['GS001-DEPR-TSIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-TSIMG'].failures.length.should.eql(1);
-
- // {{#if image}}
- output.results.fail['GS001-DEPR-CON-IMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CON-IMG'].failures.length.should.eql(1);
-
- // {{#if cover}}
- output.results.fail['GS001-DEPR-CON-COV'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CON-COV'].failures.length.should.eql(1);
-
- // {{#if tag.image}}
- output.results.fail['GS001-DEPR-CON-TIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CON-TIMG'].failures.length.should.eql(1);
-
- // {{#if tags.[#].image}}
- output.results.fail['GS001-DEPR-CON-TSIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CON-TSIMG'].failures.length.should.eql(1);
-
- // {{#if post.tags.[#].image}}
- output.results.fail['GS001-DEPR-CON-PTIMG'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CON-PTIMG'].failures.length.should.eql(1);
-
- // {{@blog.posts_per_page}}
- output.results.fail['GS001-DEPR-PPP'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-PPP'].failures.length.should.eql(1);
-
- // {{content word="0"}}
- output.results.fail['GS001-DEPR-C0H'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-C0H'].failures.length.should.eql(2);
-
- // css class .page
- output.results.fail['GS001-DEPR-CSS-PA'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CSS-PA'].failures.length.should.eql(2);
-
- // css class .page-template-{slug}
- output.results.fail['GS001-DEPR-CSS-PATS'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CSS-PATS'].failures.length.should.eql(2);
-
- // css class .achive-template
- output.results.fail['GS001-DEPR-CSS-AT'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-CSS-AT'].failures.length.should.eql(1);
-
- output.results.pass.should.be.an.Object().which.is.empty();
-
- done();
- }).catch(done);
- });
-
- it('[success] should show no error if no deprecated helpers used', function (done) {
- utils.testCheck(thisCheck, '001-deprecations/valid').then(function (output) {
- output.should.be.a.ValidThemeObject();
-
- output.results.fail.should.be.an.Object().which.is.empty();
- output.results.pass.should.be.an.Array().with.lengthOf(26);
-
- done();
- }).catch(done);
+ describe('older version passed', function () {
+ const options = {checkVersion: 'v1'};
+
+ it('[failure] theme is invalid', function (done) {
+ utils.testCheck(thisCheck, '001-deprecations/invalid', options).then(function (output) {
+ output.should.be.a.ValidThemeObject();
+
+ output.results.fail.should.be.an.Object().with.keys(
+ 'GS001-DEPR-PURL',
+ 'GS001-DEPR-MD',
+ 'GS001-DEPR-IMG',
+ 'GS001-DEPR-COV',
+ 'GS001-DEPR-AIMG',
+ 'GS001-DEPR-PIMG',
+ 'GS001-DEPR-PAIMG',
+ 'GS001-DEPR-PAC',
+ 'GS001-DEPR-PTIMG',
+ 'GS001-DEPR-TSIMG',
+ 'GS001-DEPR-PPP',
+ 'GS001-DEPR-C0H',
+ 'GS001-DEPR-BC',
+ 'GS001-DEPR-CON-BC',
+ 'GS001-DEPR-AC',
+ 'GS001-DEPR-CON-AC',
+ 'GS001-DEPR-CON-AIMG',
+ 'GS001-DEPR-CON-PTIMG',
+ 'GS001-DEPR-CON-TSIMG',
+ 'GS001-DEPR-CON-IMG',
+ 'GS001-DEPR-CON-COV',
+ 'GS001-DEPR-CON-TIMG',
+ 'GS001-DEPR-TIMG',
+ 'GS001-DEPR-CSS-AT',
+ 'GS001-DEPR-CSS-PA',
+ 'GS001-DEPR-CSS-PATS'
+ );
+
+ // pageUrl
+ output.results.fail['GS001-DEPR-PURL'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PURL'].failures.length.should.eql(3);
+
+ // meta_description in + output.results.fail['GS001-DEPR-MD'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-MD'].failures.length.should.eql(1);
+
+ // {{image}}
+ output.results.fail['GS001-DEPR-IMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-IMG'].failures.length.should.eql(2);
+
+ // {{cover}}
+ output.results.fail['GS001-DEPR-COV'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-COV'].failures.length.should.eql(3);
+
+ // {{author.image}}
+ output.results.fail['GS001-DEPR-AIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-AIMG'].failures.length.should.eql(2);
+
+ // {{post.image}}
+ output.results.fail['GS001-DEPR-PIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PIMG'].failures.length.should.eql(1);
+
+ // {{@blog.cover}}
+ output.results.fail['GS001-DEPR-BC'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-BC'].failures.length.should.eql(1);
+
+ // {{author.cover}}
+ output.results.fail['GS001-DEPR-AC'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-AC'].failures.length.should.eql(2);
+
+ // {{post.author.cover}}
+ output.results.fail['GS001-DEPR-PAC'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PAC'].failures.length.should.eql(1);
+
+ // {{post.author.image}}
+ output.results.fail['GS001-DEPR-PAIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PAIMG'].failures.length.should.eql(1);
+
+ // {{tag.image}}
+ output.results.fail['GS001-DEPR-TIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-TIMG'].failures.length.should.eql(1);
+
+ // {{posts.tags.[4].image}}
+ output.results.fail['GS001-DEPR-PTIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PTIMG'].failures.length.should.eql(1);
+
+ // {{tags.[4].image}}
+ output.results.fail['GS001-DEPR-TSIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-TSIMG'].failures.length.should.eql(1);
+
+ // {{#if image}}
+ output.results.fail['GS001-DEPR-CON-IMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-IMG'].failures.length.should.eql(1);
+
+ // {{#if cover}}
+ output.results.fail['GS001-DEPR-CON-COV'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-COV'].failures.length.should.eql(1);
+
+ // {{#if tag.image}}
+ output.results.fail['GS001-DEPR-CON-TIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-TIMG'].failures.length.should.eql(1);
+
+ // {{#if tags.[#].image}}
+ output.results.fail['GS001-DEPR-CON-TSIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-TSIMG'].failures.length.should.eql(1);
+
+ // {{#if post.tags.[#].image}}
+ output.results.fail['GS001-DEPR-CON-PTIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-PTIMG'].failures.length.should.eql(1);
+
+ // {{@blog.posts_per_page}}
+ output.results.fail['GS001-DEPR-PPP'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PPP'].failures.length.should.eql(1);
+
+ // {{content word="0"}}
+ output.results.fail['GS001-DEPR-C0H'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-C0H'].failures.length.should.eql(2);
+
+ // css class .page
+ output.results.fail['GS001-DEPR-CSS-PA'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CSS-PA'].failures.length.should.eql(2);
+
+ // css class .page-template-{slug}
+ output.results.fail['GS001-DEPR-CSS-PATS'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CSS-PATS'].failures.length.should.eql(2);
+
+ // css class .achive-template
+ output.results.fail['GS001-DEPR-CSS-AT'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CSS-AT'].failures.length.should.eql(1);
+
+ output.results.pass.should.be.an.Object().which.is.empty();
+
+ done();
+ }).catch(done);
+ });
+
+ it('[success] should show no error if no deprecated helpers used', function (done) {
+ utils.testCheck(thisCheck, '001-deprecations/valid', options).then(function (output) {
+ output.should.be.a.ValidThemeObject();
+
+ output.results.fail.should.be.an.Object().which.is.empty();
+ output.results.pass.should.be.an.Array().with.lengthOf(26);
+
+ done();
+ }).catch(done);
+ });
+
+ it('[mixed] should pass and fail when some rules pass and others fail', function (done) {
+ utils.testCheck(thisCheck, '001-deprecations/mixed', options).then(function (output) {
+ output.should.be.a.ValidThemeObject();
+
+ output.results.fail.should.be.an.Object().with.keys(
+ 'GS001-DEPR-PURL',
+ 'GS001-DEPR-MD',
+ 'GS001-DEPR-IMG',
+ 'GS001-DEPR-COV',
+ 'GS001-DEPR-PIMG',
+ 'GS001-DEPR-BC',
+ 'GS001-DEPR-TIMG',
+ 'GS001-DEPR-C0H'
+ );
+
+ output.results.fail['GS001-DEPR-PURL'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PURL'].failures.length.should.eql(2);
+ output.results.pass.should.be.an.Array().with.lengthOf(18);
+
+ done();
+ }).catch(done);
+ });
+
+ // TODO: write this as soon as we have new rules
+ it('does not check for latest versions checks');
});
- it('[mixed] should pass and fail when some rules pass and others fail', function (done) {
- utils.testCheck(thisCheck, '001-deprecations/mixed').then(function (output) {
- output.should.be.a.ValidThemeObject();
-
- output.results.fail.should.be.an.Object().with.keys(
- 'GS001-DEPR-PURL',
- 'GS001-DEPR-MD',
- 'GS001-DEPR-IMG',
- 'GS001-DEPR-COV',
- 'GS001-DEPR-PIMG',
- 'GS001-DEPR-BC',
- 'GS001-DEPR-TIMG',
- 'GS001-DEPR-C0H'
- );
-
- output.results.fail['GS001-DEPR-PURL'].should.be.a.ValidFailObject();
- output.results.fail['GS001-DEPR-PURL'].failures.length.should.eql(2);
- output.results.pass.should.be.an.Array().with.lengthOf(18);
-
- done();
- }).catch(done);
+ describe('latest version', function () {
+ it('[failure] theme is invalid', function (done) {
+ utils.testCheck(thisCheck, '001-deprecations/invalid').then(function (output) {
+ output.should.be.a.ValidThemeObject();
+
+ output.results.fail.should.be.an.Object().with.keys(
+ 'GS001-DEPR-PURL',
+ 'GS001-DEPR-MD',
+ 'GS001-DEPR-IMG',
+ 'GS001-DEPR-COV',
+ 'GS001-DEPR-AIMG',
+ 'GS001-DEPR-PIMG',
+ 'GS001-DEPR-PAIMG',
+ 'GS001-DEPR-PAC',
+ 'GS001-DEPR-PTIMG',
+ 'GS001-DEPR-TSIMG',
+ 'GS001-DEPR-PPP',
+ 'GS001-DEPR-C0H',
+ 'GS001-DEPR-BC',
+ 'GS001-DEPR-CON-BC',
+ 'GS001-DEPR-AC',
+ 'GS001-DEPR-CON-AC',
+ 'GS001-DEPR-CON-AIMG',
+ 'GS001-DEPR-CON-PTIMG',
+ 'GS001-DEPR-CON-TSIMG',
+ 'GS001-DEPR-CON-IMG',
+ 'GS001-DEPR-CON-COV',
+ 'GS001-DEPR-CON-TIMG',
+ 'GS001-DEPR-TIMG',
+ 'GS001-DEPR-CSS-AT',
+ 'GS001-DEPR-CSS-PA',
+ 'GS001-DEPR-CSS-PATS'
+ );
+
+ // pageUrl
+ output.results.fail['GS001-DEPR-PURL'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PURL'].failures.length.should.eql(3);
+
+ // meta_description in + output.results.fail['GS001-DEPR-MD'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-MD'].failures.length.should.eql(1);
+
+ // {{image}}
+ output.results.fail['GS001-DEPR-IMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-IMG'].failures.length.should.eql(2);
+
+ // {{cover}}
+ output.results.fail['GS001-DEPR-COV'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-COV'].failures.length.should.eql(3);
+
+ // {{author.image}}
+ output.results.fail['GS001-DEPR-AIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-AIMG'].failures.length.should.eql(2);
+
+ // {{post.image}}
+ output.results.fail['GS001-DEPR-PIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PIMG'].failures.length.should.eql(1);
+
+ // {{@blog.cover}}
+ output.results.fail['GS001-DEPR-BC'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-BC'].failures.length.should.eql(1);
+
+ // {{author.cover}}
+ output.results.fail['GS001-DEPR-AC'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-AC'].failures.length.should.eql(2);
+
+ // {{post.author.cover}}
+ output.results.fail['GS001-DEPR-PAC'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PAC'].failures.length.should.eql(1);
+
+ // {{post.author.image}}
+ output.results.fail['GS001-DEPR-PAIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PAIMG'].failures.length.should.eql(1);
+
+ // {{tag.image}}
+ output.results.fail['GS001-DEPR-TIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-TIMG'].failures.length.should.eql(1);
+
+ // {{posts.tags.[4].image}}
+ output.results.fail['GS001-DEPR-PTIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PTIMG'].failures.length.should.eql(1);
+
+ // {{tags.[4].image}}
+ output.results.fail['GS001-DEPR-TSIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-TSIMG'].failures.length.should.eql(1);
+
+ // {{#if image}}
+ output.results.fail['GS001-DEPR-CON-IMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-IMG'].failures.length.should.eql(1);
+
+ // {{#if cover}}
+ output.results.fail['GS001-DEPR-CON-COV'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-COV'].failures.length.should.eql(1);
+
+ // {{#if tag.image}}
+ output.results.fail['GS001-DEPR-CON-TIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-TIMG'].failures.length.should.eql(1);
+
+ // {{#if tags.[#].image}}
+ output.results.fail['GS001-DEPR-CON-TSIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-TSIMG'].failures.length.should.eql(1);
+
+ // {{#if post.tags.[#].image}}
+ output.results.fail['GS001-DEPR-CON-PTIMG'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CON-PTIMG'].failures.length.should.eql(1);
+
+ // {{@blog.posts_per_page}}
+ output.results.fail['GS001-DEPR-PPP'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PPP'].failures.length.should.eql(1);
+
+ // {{content word="0"}}
+ output.results.fail['GS001-DEPR-C0H'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-C0H'].failures.length.should.eql(2);
+
+ // css class .page
+ output.results.fail['GS001-DEPR-CSS-PA'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CSS-PA'].failures.length.should.eql(2);
+
+ // css class .page-template-{slug}
+ output.results.fail['GS001-DEPR-CSS-PATS'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CSS-PATS'].failures.length.should.eql(2);
+
+ // css class .achive-template
+ output.results.fail['GS001-DEPR-CSS-AT'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-CSS-AT'].failures.length.should.eql(1);
+
+ output.results.pass.should.be.an.Object().which.is.empty();
+
+ done();
+ }).catch(done);
+ });
+
+ it('[success] should show no error if no deprecated helpers used', function (done) {
+ utils.testCheck(thisCheck, '001-deprecations/valid').then(function (output) {
+ output.should.be.a.ValidThemeObject();
+
+ output.results.fail.should.be.an.Object().which.is.empty();
+ output.results.pass.should.be.an.Array().with.lengthOf(26);
+
+ done();
+ }).catch(done);
+ });
+
+ it('[mixed] should pass and fail when some rules pass and others fail', function (done) {
+ utils.testCheck(thisCheck, '001-deprecations/mixed').then(function (output) {
+ output.should.be.a.ValidThemeObject();
+
+ output.results.fail.should.be.an.Object().with.keys(
+ 'GS001-DEPR-PURL',
+ 'GS001-DEPR-MD',
+ 'GS001-DEPR-IMG',
+ 'GS001-DEPR-COV',
+ 'GS001-DEPR-PIMG',
+ 'GS001-DEPR-BC',
+ 'GS001-DEPR-TIMG',
+ 'GS001-DEPR-C0H'
+ );
+
+ output.results.fail['GS001-DEPR-PURL'].should.be.a.ValidFailObject();
+ output.results.fail['GS001-DEPR-PURL'].failures.length.should.eql(2);
+ output.results.pass.should.be.an.Array().with.lengthOf(18);
+
+ done();
+ }).catch(done);
+ });
});
});
diff --git a/test/005-template-compile.test.js b/test/005-template-compile.test.js
index eb06ae1f8..cc8c4da0e 100644
--- a/test/005-template-compile.test.js
+++ b/test/005-template-compile.test.js
@@ -3,8 +3,10 @@ var should = require('should'), // eslint-disable-line no-unused-vars
thisCheck = require('../lib/checks/005-template-compile');
describe('Template compile', function () {
+ const options = {checkVersion: 'v1'};
+
it('should output empty array for a theme with no templates', function (done) {
- utils.testCheck(thisCheck, 'is-empty').then(function (output) {
+ utils.testCheck(thisCheck, 'is-empty', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.fail.should.be.an.Object().which.is.empty();
@@ -16,7 +18,7 @@ describe('Template compile', function () {
});
it('should output empty array for a theme with valid templates', function (done) {
- utils.testCheck(thisCheck, '005-compile/valid').then(function (output) {
+ utils.testCheck(thisCheck, '005-compile/valid', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.fail.should.be.an.Object().which.is.empty();
@@ -29,7 +31,7 @@ describe('Template compile', function () {
});
it('should output errors for a theme with invalid templates', function (done) {
- utils.testCheck(thisCheck, '005-compile/invalid').then(function (output) {
+ utils.testCheck(thisCheck, '005-compile/invalid', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().which.is.empty();
@@ -57,7 +59,7 @@ describe('Template compile', function () {
});
it('theme with partials and unknown helper', function (done) {
- utils.testCheck(thisCheck, 'theme-with-partials').then(function (output) {
+ utils.testCheck(thisCheck, 'theme-with-partials', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.fail.should.be.an.Object().with.keys('GS005-TPL-ERR');
diff --git a/test/010-package-json.test.js b/test/010-package-json.test.js
index 72222072a..e9793dac8 100644
--- a/test/010-package-json.test.js
+++ b/test/010-package-json.test.js
@@ -3,8 +3,10 @@ var should = require('should'), // eslint-disable-line no-unused-vars
thisCheck = require('../lib/checks/010-package-json');
describe('010: package.json', function () {
+ const options = {checkVersion: 'v1'};
+
it('should output error for missing package.json', function (done) {
- utils.testCheck(thisCheck, 'is-empty').then(function (output) {
+ utils.testCheck(thisCheck, 'is-empty', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().with.lengthOf(0);
@@ -29,7 +31,7 @@ describe('010: package.json', function () {
});
it('should output error for missing package.json', function (done) {
- utils.testCheck(thisCheck, 'is-empty').then(function (output) {
+ utils.testCheck(thisCheck, 'is-empty', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().with.lengthOf(0);
@@ -54,7 +56,7 @@ describe('010: package.json', function () {
});
it('should output error for invalid package.json (parsing)', function (done) {
- utils.testCheck(thisCheck, '010-packagejson/parse-error').then(function (output) {
+ utils.testCheck(thisCheck, '010-packagejson/parse-error', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().with.lengthOf(0);
@@ -82,7 +84,7 @@ describe('010: package.json', function () {
});
it('valid fields', function (done) {
- utils.testCheck(thisCheck, '010-packagejson/fields-are-valid').then(function (theme) {
+ utils.testCheck(thisCheck, '010-packagejson/fields-are-valid', options).then(function (theme) {
theme.should.be.a.ValidThemeObject();
theme.results.pass.should.eql([
@@ -105,7 +107,7 @@ describe('010: package.json', function () {
});
it('invalid fields', function (done) {
- utils.testCheck(thisCheck, '010-packagejson/fields-are-invalid').then(function (theme) {
+ utils.testCheck(thisCheck, '010-packagejson/fields-are-invalid', options).then(function (theme) {
theme.should.be.a.ValidThemeObject();
theme.results.pass.should.eql([
@@ -129,7 +131,7 @@ describe('010: package.json', function () {
});
it('missing fields', function (done) {
- utils.testCheck(thisCheck, '010-packagejson/fields-are-missing').then(function (theme) {
+ utils.testCheck(thisCheck, '010-packagejson/fields-are-missing', options).then(function (theme) {
theme.should.be.a.ValidThemeObject();
theme.results.pass.should.eql([
@@ -153,7 +155,7 @@ describe('010: package.json', function () {
});
it('bad config (ppp: -3 > 0)', function (done) {
- utils.testCheck(thisCheck, '010-packagejson/bad-config').then(function (theme) {
+ utils.testCheck(thisCheck, '010-packagejson/bad-config', options).then(function (theme) {
theme.should.be.a.ValidThemeObject();
theme.results.pass.should.eql([
@@ -177,7 +179,7 @@ describe('010: package.json', function () {
});
it('bad config 2 (ppp: 0 > 0)', function (done) {
- utils.testCheck(thisCheck, '010-packagejson/bad-config-2').then(function (theme) {
+ utils.testCheck(thisCheck, '010-packagejson/bad-config-2', options).then(function (theme) {
theme.should.be.a.ValidThemeObject();
theme.results.pass.should.eql([
diff --git a/test/020-theme-structure.test.js b/test/020-theme-structure.test.js
index 8a5a5dc44..87cf1af27 100644
--- a/test/020-theme-structure.test.js
+++ b/test/020-theme-structure.test.js
@@ -4,8 +4,10 @@ var should = require('should'), // eslint-disable-line no-unused-vars
thisCheck = require('../lib/checks/020-theme-structure');
describe('Theme structure', function () {
+ const options = {checkVersion: 'v1'};
+
it('should fail all rules if no files present', function (done) {
- utils.testCheck(thisCheck, 'is-empty').then(function (output) {
+ utils.testCheck(thisCheck, 'is-empty', options).then(function (output) {
output.should.be.a.ValidThemeObject();
// Should not pass any rules
@@ -21,7 +23,7 @@ describe('Theme structure', function () {
});
it('should pass and fail when some rules pass and others fail', function (done) {
- utils.testCheck(thisCheck, '020-structure/mixed').then(function (output) {
+ utils.testCheck(thisCheck, '020-structure/mixed', options).then(function (output) {
output.should.be.a.ValidThemeObject();
// Should pass the index rule
@@ -38,7 +40,7 @@ describe('Theme structure', function () {
});
it('should still fail with just a recommendation', function (done) {
- utils.testCheck(thisCheck, '020-structure/recommendation').then(function (output) {
+ utils.testCheck(thisCheck, '020-structure/recommendation', options).then(function (output) {
output.should.be.a.ValidThemeObject();
// Should not pass any rules
diff --git a/test/030-assets.test.js b/test/030-assets.test.js
index 9bb72ce00..f5cd5b5a9 100644
--- a/test/030-assets.test.js
+++ b/test/030-assets.test.js
@@ -3,8 +3,10 @@ var should = require('should'), // eslint-disable-line no-unused-vars
thisCheck = require('../lib/checks/030-assets');
describe('Assets', function () {
+ const options = {checkVersion: 'v1'};
+
it('should show a warning for missing asset helper when an asset is detected', function (done) {
- utils.testCheck(thisCheck, '030-assets/missing').then(function (output) {
+ utils.testCheck(thisCheck, '030-assets/missing', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().with.lengthOf(1);
@@ -22,7 +24,7 @@ describe('Assets', function () {
});
it('should pass when asset helper is present', function (done) {
- utils.testCheck(thisCheck, '030-assets/valid').then(function (output) {
+ utils.testCheck(thisCheck, '030-assets/valid', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.fail.should.be.an.Object().which.is.empty();
@@ -36,7 +38,7 @@ describe('Assets', function () {
});
it('should show error when symlink is present', function (done) {
- utils.testCheck(thisCheck, '030-assets/symlink').then(function (output) {
+ utils.testCheck(thisCheck, '030-assets/symlink', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().with.lengthOf(1);
diff --git a/test/040-ghost-head-foot.test.js b/test/040-ghost-head-foot.test.js
index ed12b2056..1fd46b83c 100644
--- a/test/040-ghost-head-foot.test.js
+++ b/test/040-ghost-head-foot.test.js
@@ -3,8 +3,10 @@ var should = require('should'), // eslint-disable-line no-unused-vars
thisCheck = require('../lib/checks/040-ghost-head-foot');
describe('Ghost head & foot', function () {
+ const options = {checkVersion: 'v1'};
+
it('should show warnings for missing ghost head & foot helpers when no .hbs files are present', function (done) {
- utils.testCheck(thisCheck, 'is-empty').then(function (output) {
+ utils.testCheck(thisCheck, 'is-empty', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().which.is.empty();
@@ -19,7 +21,7 @@ describe('Ghost head & foot', function () {
});
it('should show warnings for missing ghost head & foot helpers when they are not in any .hbs file', function (done) {
- utils.testCheck(thisCheck, '040-head-foot/missing').then(function (output) {
+ utils.testCheck(thisCheck, '040-head-foot/missing', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().which.is.empty();
@@ -34,7 +36,7 @@ describe('Ghost head & foot', function () {
});
it('should output nothing when ghost head & foot helpers are present', function (done) {
- utils.testCheck(thisCheck, '040-head-foot/valid').then(function (output) {
+ utils.testCheck(thisCheck, '040-head-foot/valid', options).then(function (output) {
output.should.be.a.ValidThemeObject();
output.results.pass.should.be.an.Array().with.lengthOf(2);
diff --git a/test/general.test.js b/test/general.test.js
index 5e3a75d7a..5196d6525 100644
--- a/test/general.test.js
+++ b/test/general.test.js
@@ -1,17 +1,17 @@
-var should = require('should'),
- sinon = require('sinon'),
- path = require('path'),
- rewire = require('rewire'),
- _ = require('lodash'),
- pfs = require('../lib/promised-fs'),
- checkZip = require('../lib').checkZip,
- themePath = require('./utils').themePath,
- readZip = require('../lib/read-zip'),
- readTheme = rewire('../lib/read-theme'),
- checker = require('../lib/checker'),
- format = require('../lib/format'),
-
- sandbox = sinon.sandbox.create();
+const should = require('should');
+const sinon = require('sinon');
+const path = require('path');
+const rewire = require('rewire');
+const _ = require('lodash');
+const pfs = require('../lib/promised-fs');
+const checkZip = require('../lib').checkZip;
+const themePath = require('./utils').themePath;
+const readZip = require('../lib/read-zip');
+const readTheme = rewire('../lib/read-theme');
+const checker = require('../lib/checker');
+const format = require('../lib/format');
+
+const sandbox = sinon.sandbox.create();
process.env.NODE_ENV = 'testing';
@@ -29,7 +29,7 @@ function testReadZip(name) {
}
describe('Zip file handler can read zip files', function () {
- after(function (done) {
+ after((done) => {
pfs.remove('./test/tmp', function (err) {
done(err);
});
@@ -40,90 +40,96 @@ describe('Zip file handler can read zip files', function () {
});
it('Flat example: zip without folder should unzip and callback with a path', function (done) {
- testReadZip('flat-example.zip').then(function (zip) {
- zip.path.should.be.a.String;
- zip.origPath.should.be.a.String;
- zip.name.should.be.a.String;
- zip.origName.should.be.a.String;
- zip.path.should.not.match(/flat-example$/);
- zip.path.should.eql(zip.origPath);
- zip.origName.should.eql('flat-example');
- done();
- }).catch(done);
+ testReadZip('flat-example.zip')
+ .then((zip) => {
+ zip.path.should.be.a.String;
+ zip.origPath.should.be.a.String;
+ zip.name.should.be.a.String;
+ zip.origName.should.be.a.String;
+ zip.path.should.not.match(/flat-example$/);
+ zip.path.should.eql(zip.origPath);
+ zip.origName.should.eql('flat-example');
+ done();
+ }).catch(done);
});
it('Simple example: zip with same-name folder should unzip and callback with a path, resolving base dir', function (done) {
- testReadZip('example.zip').then(function (zip) {
- zip.path.should.be.a.String;
- zip.origPath.should.be.a.String;
- zip.name.should.be.a.String;
- zip.origName.should.be.a.String;
- zip.path.should.match(/\/example$/);
- zip.path.should.not.eql(zip.origPath);
- zip.origName.should.eql('example');
- done();
- }).catch(done);
+ testReadZip('example.zip')
+ .then((zip) => {
+ zip.path.should.be.a.String;
+ zip.origPath.should.be.a.String;
+ zip.name.should.be.a.String;
+ zip.origName.should.be.a.String;
+ zip.path.should.match(/\/example$/);
+ zip.path.should.not.eql(zip.origPath);
+ zip.origName.should.eql('example');
+ done();
+ }).catch(done);
});
it('Bad example: zip with dif-name folder should unzip and callback with a path, resolving base dir', function (done) {
- testReadZip('bad-example.zip').then(function (zip) {
- zip.path.should.be.a.String;
- zip.origPath.should.be.a.String;
- zip.name.should.be.a.String;
- zip.origName.should.be.a.String;
- zip.path.should.match(/\/bad-example-folder/);
- zip.path.should.not.eql(zip.origPath);
- zip.origName.should.eql('bad-example');
- done();
- }).catch(done);
+ testReadZip('bad-example.zip')
+ .then((zip) => {
+ zip.path.should.be.a.String;
+ zip.origPath.should.be.a.String;
+ zip.name.should.be.a.String;
+ zip.origName.should.be.a.String;
+ zip.path.should.match(/\/bad-example-folder/);
+ zip.path.should.not.eql(zip.origPath);
+ zip.origName.should.eql('bad-example');
+ done();
+ }).catch(done);
});
it('Nested example: zip with nested folders should unzip and callback with a path, resolving base dir', function (done) {
- testReadZip('nested-example.zip').then(function (zip) {
- zip.path.should.be.a.String;
- zip.origPath.should.be.a.String;
- zip.name.should.be.a.String;
- zip.origName.should.be.a.String;
- zip.path.should.match(/\/nested-example\/bad-example-folder$/);
- zip.path.should.not.eql(zip.origPath);
- zip.origName.should.eql('nested-example');
- done();
- }).catch(done);
+ testReadZip('nested-example.zip')
+ .then((zip) => {
+ zip.path.should.be.a.String;
+ zip.origPath.should.be.a.String;
+ zip.name.should.be.a.String;
+ zip.origName.should.be.a.String;
+ zip.path.should.match(/\/nested-example\/bad-example-folder$/);
+ zip.path.should.not.eql(zip.origPath);
+ zip.origName.should.eql('nested-example');
+ done();
+ }).catch(done);
});
it('Multi example: complex zip should unzip and callback with a path, resolving base dir', function (done) {
- testReadZip('multi-example.zip').then(function (zip) {
- zip.path.should.be.a.String;
- zip.origPath.should.be.a.String;
- zip.name.should.be.a.String;
- zip.origName.should.be.a.String;
- zip.path.should.match(/\/multi-example\/theme\/theme-name/);
- zip.path.should.not.eql(zip.origPath);
- zip.origName.should.eql('multi-example');
- done();
- }).catch(done);
+ testReadZip('multi-example.zip')
+ .then((zip) => {
+ zip.path.should.be.a.String;
+ zip.origPath.should.be.a.String;
+ zip.name.should.be.a.String;
+ zip.origName.should.be.a.String;
+ zip.path.should.match(/\/multi-example\/theme\/theme-name/);
+ zip.path.should.not.eql(zip.origPath);
+ zip.origName.should.eql('multi-example');
+ done();
+ }).catch(done);
});
// If the zip file does not contain index.hbs, we return the standard path, and our checks will report the errors
it('No index.hbs example: zip should unzip and callback with a path', function (done) {
- testReadZip('not-a-theme.zip').then(function (zip) {
- zip.path.should.be.a.String;
- zip.origPath.should.be.a.String;
- zip.name.should.be.a.String;
- zip.origName.should.be.a.String;
- zip.path.should.not.match(/not-a-theme$/);
- zip.path.should.eql(zip.origPath);
- zip.origName.should.eql('not-a-theme');
- done();
- }).catch(done);
+ testReadZip('not-a-theme.zip')
+ .then((zip) => {
+ zip.path.should.be.a.String;
+ zip.origPath.should.be.a.String;
+ zip.name.should.be.a.String;
+ zip.origName.should.be.a.String;
+ zip.path.should.not.match(/not-a-theme$/);
+ zip.path.should.eql(zip.origPath);
+ zip.origName.should.eql('not-a-theme');
+ done();
+ }).catch(done);
});
});
describe('check zip', function () {
describe('ensure ignored assets are getting ignored', function () {
it('default', function () {
- return checkZip(themePath('030-assets/ignored.zip'), {keepExtractedDir: true})
- .then(function (theme) {
+ return checkZip(themePath('030-assets/ignored.zip'), {keepExtractedDir: true, checkVersion: 'v1'})
+ .then((theme) => {
theme.files.length.should.eql(1);
theme.files[0].file.should.match(/default\.hbs/);
@@ -135,8 +141,8 @@ describe('check zip', function () {
});
it('Don\'t remove files if theme not in tmp directory', function () {
- return checker(themePath('030-assets/ignored'))
- .then(function (theme) {
+ return checker(themePath('030-assets/ignored'), {checkVersion: 'v1'})
+ .then((theme) => {
theme.files.length.should.eql(1);
theme.files[0].file.should.match(/default\.hbs/);
@@ -151,7 +157,7 @@ describe('check zip', function () {
describe('Read theme', function () {
it('returns correct result', function (done) {
- readTheme(themePath('is-empty')).then(function (theme) {
+ readTheme(themePath('is-empty')).then((theme) => {
theme.should.be.a.ValidThemeObject();
theme.files.should.eql([
@@ -163,12 +169,12 @@ describe('Read theme', function () {
});
it('Can read partials', function (done) {
- readTheme(themePath('theme-with-partials')).then(function (theme) {
+ readTheme(themePath('theme-with-partials')).then((theme) => {
theme.should.be.a.ValidThemeObject();
theme.files.should.be.an.Array().with.lengthOf(7);
- var fileNames = _.map(theme.files, function (file) {
+ const fileNames = _.map(theme.files, function (file) {
return _.pickBy(file, function (value, key) {
return key === 'file' || key === 'ext';
});
@@ -187,7 +193,7 @@ describe('Read theme', function () {
});
it('Can extract custom templates', function (done) {
- readTheme(themePath('theme-with-custom-templates')).then(function (theme) {
+ readTheme(themePath('theme-with-custom-templates')).then((theme) => {
theme.should.be.a.ValidThemeObject();
theme.files.should.be.an.Array().with.lengthOf(11);
@@ -262,7 +268,7 @@ describe('Read Hbs Files', function () {
it('can read partials with POSIX paths', function (done) {
// This roughly matches Example I
- var exampleI = [
+ const exampleI = [
{file: 'index.hbs', ext: '.hbs'},
{file: 'package.json', ext: '.json'},
{file: 'partialsbroke.hbs', ext: '.hbs'},
@@ -276,7 +282,7 @@ describe('Read Hbs Files', function () {
readTheme.__get__('readHbsFiles')({
files: exampleI,
path: 'fake/example-i'
- }).then(function (result) {
+ }).then((result) => {
result.partials.should.be.an.Array().with.lengthOf(2);
result.partials.should.eql(['mypartial', 'subfolder/test']);
done();
@@ -285,7 +291,7 @@ describe('Read Hbs Files', function () {
it('can read partials with windows paths', function (done) {
// This matches Example I, but on Windows
- var exampleI = [
+ const exampleI = [
{file: 'index.hbs', ext: '.hbs'},
{file: 'package.json', ext: '.json'},
{file: 'partialsbroke.hbs', ext: '.hbs'},
@@ -298,7 +304,7 @@ describe('Read Hbs Files', function () {
files: exampleI,
path: 'fake\\example-i'
})
- .then(function (result) {
+ .then((result) => {
result.partials.should.be.an.Array().with.lengthOf(2);
result.partials.should.eql(['mypartial', 'subfolder\\test']);
done();
@@ -308,7 +314,42 @@ describe('Read Hbs Files', function () {
describe('Checker', function () {
it('returns a valid theme when running all checks', function (done) {
- checker(themePath('is-empty')).then(function (theme) {
+ checker(themePath('is-empty')).then((theme) => {
+ theme.should.be.a.ValidThemeObject();
+
+ theme.files.should.eql([
+ {file: '.gitkeep', ext: '.gitkeep'},
+ {file: 'README.md', ext: '.md'}
+ ]);
+
+ theme.results.pass.should.be.an.Array().with.lengthOf(31);
+ theme.results.pass.should.containEql('GS005-TPL-ERR', 'GS030-ASSET-REQ', 'GS030-ASSET-SYM');
+
+ theme.results.fail.should.be.an.Object().with.keys(
+ 'GS010-PJ-REQ',
+ 'GS010-PJ-PARSE',
+ 'GS010-PJ-NAME-REQ',
+ 'GS010-PJ-NAME-LC',
+ 'GS010-PJ-NAME-HY',
+ 'GS010-PJ-VERSION-SEM',
+ 'GS010-PJ-VERSION-REQ',
+ 'GS010-PJ-AUT-EM-VAL',
+ 'GS010-PJ-AUT-EM-REQ',
+ 'GS010-PJ-CONF-PPP',
+ 'GS020-INDEX-REQ',
+ 'GS020-POST-REQ',
+ 'GS020-DEF-REC',
+ 'GS040-GH-REQ',
+ 'GS040-GF-REQ'
+ );
+
+ done();
+ });
+ });
+
+ // TODO: this needs to be activated as soon as we have new checks for the ruleset
+ it.skip('checks for an older version if passed', function (done) {
+ checker(themePath('is-empty'), {checkVersion: 'v1'}).then((theme) => {
theme.should.be.a.ValidThemeObject();
theme.files.should.eql([
@@ -342,7 +383,7 @@ describe('Checker', function () {
});
it('should not follow symlinks', function (done) {
- checker(themePath('030-assets/symlink2')).then(function (theme) {
+ checker(themePath('030-assets/symlink2')).then((theme) => {
theme.should.be.a.ValidThemeObject();
theme.files.should.containEql({file: 'assets/mysymlink', ext: undefined});
theme.results.fail.should.containEql('GS030-ASSET-SYM');
@@ -354,7 +395,7 @@ describe('Checker', function () {
describe('format', function () {
it('assert sorting', function (done) {
- checker(themePath('005-compile/invalid')).then(function (theme) {
+ checker(themePath('005-compile/invalid')).then((theme) => {
theme = format(theme);
theme.results.error[0].fatal.should.eql(true);
@@ -366,7 +407,7 @@ describe('format', function () {
});
it('assert sorting', function (done) {
- checker(themePath('is-empty')).then(function (theme) {
+ checker(themePath('is-empty')).then((theme) => {
theme = format(theme);
theme.results.error[0].fatal.should.eql(true);
diff --git a/test/utils.js b/test/utils.js
index a767b0f44..f26879115 100644
--- a/test/utils.js
+++ b/test/utils.js
@@ -56,7 +56,7 @@ testCheck = function testCheck(checkLib, themeId, options) {
var themePath = getThemePath(themeId);
return readTheme(themePath).then(function runCheck(theme) {
- return checkLib.call(this, theme, themePath, options);
+ return checkLib.call(this, theme, options, themePath);
});
};