Merge pull request #675 from leviy/master_implement-deprecated-tag

Add support for 'deprecated' tag
twigjs · Nov 1, 2019 · 8270a18 · 8270a18
2 parents 74073f5 + a3f0fc0
commit 8270a18
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/src/twig.logic.js b/src/twig.logic.js
@@ -41,7 +41,8 @@ module.exports = function (Twig) {
  embed: 'Twig.logic.type.embed',
  endembed: 'Twig.logic.type.endembed',
  with: 'Twig.logic.type.with',
- endwith: 'Twig.logic.type.endwith'
+ endwith: 'Twig.logic.type.endwith',
+ deprecated: 'Twig.logic.type.deprecated'
  };
 
  // Regular expressions for handling logic tokens.
@@ -1272,6 +1273,25 @@ module.exports = function (Twig) {
  regex: /^endwith$/,
  next: [],
  open: false
+ },
+ {
+ /**
+ * Deprecated type logic tokens.
+ *
+ * Format: {% deprecated 'Description' %}
+ */
+ type: Twig.logic.type.deprecated,
+ regex: /^deprecated\s+(.+)$/,
+ next: [],
+ open: true,
+ compile(token) {
+ console.warn('Deprecation notice: ' + token.match[1]);
+
+ return token;
+ },
+ parse() {
+ return {};
+ }
  }
 
  ];

diff --git a/test/test.tags.js b/test/test.tags.js
@@ -1,4 +1,5 @@
 const Twig = require('../twig').factory();
+const sinon = require('sinon');
 
 const {twig} = Twig;
 
@@ -53,4 +54,14 @@ describe('Twig.js Tags ->', function () {
  '&lt;strong&gt;twig.js&lt;/strong&gt;'
  );
  });
+
+ it('should support deprecated tag and show a console warn message', function () {
+ let consoleSpy = sinon.spy(console, 'warn');
+
+ twig({
+ data: '{% deprecated \'`foo` is deprecated use `bar`\' %}'
+ }).render();
+
+ consoleSpy.should.be.calledWith('Deprecation notice: \'`foo` is deprecated use `bar`\'');
+ });
 });