Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@bam.tech/kettle
Advanced tools
The templating engine tailored for boilerplates
As templating engines were historically tailored for the needs of server side rendering they allow for powerful integration of conditions, loops, replacements, includes, ... but don't care about breaking syntax.
The consequence is that when using those engines for boilerplate templating it breaks the code and prevents you from using tools such as linting, typings and unit tests live while templating. Thus, making the development cycle of a boilerplate tedious.
Kettle aims to bring the power of templating without breaking any syntax by focusing only on basic tools and leveraging comments available in (almost) any programing language.
yarn add @bam.tech/kettle
npm install @bam.tech/kettle
It is recommended to use Kettle using Gulp
const { src, dest } = require('gulp');
const { transformFactory } = require('kettle');
src(['path/to/template'])
.pipe(
transformFactory({
values: {
isTrue: true,
isFalse: false,
appName: 'myApp',
functionName: 'myFunction',
},
})
)
.pipe(dest('path/to/output'));
Kettle replaces values in paths:
path/to/__replace__appName__/file.env
will output path/to/myApp/file.env
With path/to/__replace__appName____if__isTrue__/subFolder__if__isTrue__/file.env
, the resulting file will appear in the written file at the path path/to/myApp/subFolder/file.env
With path/to/__replace__appName__/subFolder__if__isFalse__/file.env
, Kettle will not write any file
With a // __include_if_isTrue_
comment, the file will be included and the comment line removed
With a // __include_if_isFalse_
comment, the file will not be included in the output at all
You can also chain conditions with multiple include lines. The position of the comment in the file does not matter
// __include_if_isTrue_
// __include_if_isFalse_
const thisFileWillNotBeRendered = true;
It is possible to reverse assertions using !
For example, path/to/__replace__appName__/subFolder__if__!isFalse__/file.env
will render path/to/myApp/subFolder/file.env
In files content, Kettle will turn this:
const import1 = require('path/to/imports1__if__isFalse__/import1.js');
const import2 = require('path/to/imports2__if__isTrue__/import2.js');
const import2 = require('path/to/imports2__if__!isTrue__/import2.js');
// __if__isTrue__
__replace__functionName__();
console.log('__replace__appName__');
// __endif__
// __if__isFalse__
shouldNotAppear();
// __endif__
// __if__!isTrue__
shouldNotAppear();
// __endif__
into
const import2 = require('path/to/imports1/import1.js');
myFunction();
console.log('myApp');
//
#
Sometimes it is impossible to use characters such as "_" in strings. To allow for some edge cases, a search and replace tool has been included. It is recommended to avoid using this method.
transformFactory({
replaceList: [
{
from: 'foo',
to: 'hello',
},
{
from: 'Bar',
to: 'World',
},
],
});
This will transform all occurences of foo
and Bar
. fooBar
will become helloWorld
It is possible to customize the __replace__<myVar>__
, __if__<myVar>__
and __endif__
blocks.
Examples are provided in kettle.replace.test.ts
To highlight Kettle syntax it is advised to install the VSCode Highlight plugin and use the following rules in .vscode/settings.json
:
{
"highlight.regexes": {
"(.*?__if__)(!.+?)(__.*?)\\n": [
{
"backgroundColor": "#a06f5f",
"color": "#FFF"
},
{
"backgroundColor": "#a06f5f",
"color": "#ffbfb4",
"fontWeight": "bold"
},
{
"backgroundColor": "#a06f5f",
"color": "#FFF"
}
],
"(.*?__if__)([^!]+?)(__.*?)\\n": [
{
"backgroundColor": "#a06f5f",
"color": "#FFF"
},
{
"backgroundColor": "#a06f5f",
"color": "#c7ffa4",
"fontWeight": "bold"
},
{
"backgroundColor": "#a06f5f",
"color": "#FFF"
}
],
"((?:\\/\\/|#) __if__)([^!]+?)(__)": [
{
"backgroundColor": "#808080",
"color": "#FFF"
},
{
"backgroundColor": "#808080",
"color": "#c7ffa4",
"fontWeight": "bold"
},
{
"backgroundColor": "#808080",
"color": "#FFF"
}
],
"((?:\\/\\/|#) __if__)(!.+?)(__)": [
{
"backgroundColor": "#808080",
"color": "#FFF"
},
{
"backgroundColor": "#808080",
"color": "#ffbfb4",
"fontWeight": "bold"
},
{
"backgroundColor": "#808080",
"color": "#FFF"
}
],
"((?:\\/\\/|#) __endif__)": [
{
"backgroundColor": "#808080",
"color": "#FFF"
}
],
"(__replace__)(.+?)(__)": [
{
"backgroundColor": "#5F9EA0",
"color": "#FFF"
},
{
"backgroundColor": "#5F9EA0",
"color": "#FFF",
"fontWeight": "bold"
},
{
"backgroundColor": "#5F9EA0",
"color": "#FFF"
}
]
}
}
FAQs
The templating engine tailored for boilerplates
We found that @bam.tech/kettle demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 12 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.