filesafe/src/README.md

# README

`versions.json` is the file that tells Nunjucks what version strings to append to client-side lolisafe assets (only crucial if you use [Cache-Control](#cache-control)).

To bump the version, it's recommended to use use `yarn bump-versions`.

```none
$ yarn bump-versions
$ node ./scripts/bump-versions.js
Bump version strings for client-side assets.

Usage:
node scripts/bump-versions.js <types>

types:
Space separated list of types (accepts 1 to 5).
1: CSS and JS files (lolisafe core assets + fontello.css).
2: Icons, images and config files (manifest.json, browserconfig.xml, etc).
3: CSS and JS files (libs from /public/libs, such as bulma, lazyload, etc).
4: Renders from /public/render/* directories (to be used with /src/js/misc/render.js).
5: Fontello font files.
a: Shortcut to update all types.
```

By default, running `yarn build` will also run `node ./scripts/bump-versions.js 1`.

## Fontello

`fontello.css` itself will use type 1, but its font files will use type 5.

Gulp will automatically append the version string into the built `fontello.css` in `dist` directory when running `yarn build` (or `dist-dev` when running `yarn develop`).

To bump type 5, you would have to run `yarn bump-versions 5`.

## Cache-Control

Version strings will NOT be used when `cacheControl` in `config.js` is not enabled, since they are only necessary when the assets are being cached indefinitely in browsers.

However, type 5 will still be appended to the built `fontello.css` if it exists in `versions.json` file.
Updated Removed version strings from _globals.njk, in favor of src/versions.json. That versions in that file can be bumped with "yarn bump-versions". v1 is automatically bumped when doing "yarn build" as well. Added README file in src directory, explaining versions.json file. Added README file in scripts directory, detailing usage of each scripts. Version strings will no longer be appended when cacheControl is disabled in config file. After all, version strings are only needed when the static assets are cached indefinitely in users' browsers. Initial Cloudflare's cache purging will no longer be executed when cloudflare -> purgeCache is disabled, even if cacheControl is enabled. Just in case someone wants to use version strings for other use cases. Actually use custom metaDesc variable on meta description tag. 2019-09-19 12:10:37 +00:00			`# README`

chore: improved some README.md's 2022-06-28 01:17:02 +00:00			`versions.json` is the file that tells Nunjucks what version strings to append to client-side lolisafe assets (only crucial if you use [Cache-Control](#cache-control)).
Updated Removed version strings from _globals.njk, in favor of src/versions.json. That versions in that file can be bumped with "yarn bump-versions". v1 is automatically bumped when doing "yarn build" as well. Added README file in src directory, explaining versions.json file. Added README file in scripts directory, detailing usage of each scripts. Version strings will no longer be appended when cacheControl is disabled in config file. After all, version strings are only needed when the static assets are cached indefinitely in users' browsers. Initial Cloudflare's cache purging will no longer be executed when cloudflare -> purgeCache is disabled, even if cacheControl is enabled. Just in case someone wants to use version strings for other use cases. Actually use custom metaDesc variable on meta description tag. 2019-09-19 12:10:37 +00:00
			To bump the version, it's recommended to use use `yarn bump-versions`.

			```none
			`$ yarn bump-versions`
chore: improved some README.md's 2022-06-28 01:17:02 +00:00			`$ node ./scripts/bump-versions.js`
Updated Removed version strings from _globals.njk, in favor of src/versions.json. That versions in that file can be bumped with "yarn bump-versions". v1 is automatically bumped when doing "yarn build" as well. Added README file in src directory, explaining versions.json file. Added README file in scripts directory, detailing usage of each scripts. Version strings will no longer be appended when cacheControl is disabled in config file. After all, version strings are only needed when the static assets are cached indefinitely in users' browsers. Initial Cloudflare's cache purging will no longer be executed when cloudflare -> purgeCache is disabled, even if cacheControl is enabled. Just in case someone wants to use version strings for other use cases. Actually use custom metaDesc variable on meta description tag. 2019-09-19 12:10:37 +00:00			`Bump version strings for client-side assets.`

			`Usage:`
			`node scripts/bump-versions.js <types>`

			`types:`
Updated src/README.md 2020-04-19 18:54:54 +00:00			`Space separated list of types (accepts 1 to 5).`
Updated Removed version strings from _globals.njk, in favor of src/versions.json. That versions in that file can be bumped with "yarn bump-versions". v1 is automatically bumped when doing "yarn build" as well. Added README file in src directory, explaining versions.json file. Added README file in scripts directory, detailing usage of each scripts. Version strings will no longer be appended when cacheControl is disabled in config file. After all, version strings are only needed when the static assets are cached indefinitely in users' browsers. Initial Cloudflare's cache purging will no longer be executed when cloudflare -> purgeCache is disabled, even if cacheControl is enabled. Just in case someone wants to use version strings for other use cases. Actually use custom metaDesc variable on meta description tag. 2019-09-19 12:10:37 +00:00			`1: CSS and JS files (lolisafe core assets + fontello.css).`
			`2: Icons, images and config files (manifest.json, browserconfig.xml, etc).`
			`3: CSS and JS files (libs from /public/libs, such as bulma, lazyload, etc).`
			`4: Renders from /public/render/* directories (to be used with /src/js/misc/render.js).`
Updated Added gulp-replace dev dependency. Removed version strings of Fontello fonts from fontello.css Added "build:fontello" Gulp task which will append version string to Fontello fonts, then do the usual processing for CSS file. It will use type 5 from versions.json, if available. Also updated src/README.md about it. 2019-09-19 13:39:23 +00:00			`5: Fontello font files.`
Updated Removed version strings from _globals.njk, in favor of src/versions.json. That versions in that file can be bumped with "yarn bump-versions". v1 is automatically bumped when doing "yarn build" as well. Added README file in src directory, explaining versions.json file. Added README file in scripts directory, detailing usage of each scripts. Version strings will no longer be appended when cacheControl is disabled in config file. After all, version strings are only needed when the static assets are cached indefinitely in users' browsers. Initial Cloudflare's cache purging will no longer be executed when cloudflare -> purgeCache is disabled, even if cacheControl is enabled. Just in case someone wants to use version strings for other use cases. Actually use custom metaDesc variable on meta description tag. 2019-09-19 12:10:37 +00:00			`a: Shortcut to update all types.`
			```

			By default, running `yarn build` will also run `node ./scripts/bump-versions.js 1`.

Updated Added gulp-replace dev dependency. Removed version strings of Fontello fonts from fontello.css Added "build:fontello" Gulp task which will append version string to Fontello fonts, then do the usual processing for CSS file. It will use type 5 from versions.json, if available. Also updated src/README.md about it. 2019-09-19 13:39:23 +00:00			`## Fontello`

			`fontello.css` itself will use type 1, but its font files will use type 5.

			Gulp will automatically append the version string into the built `fontello.css` in `dist` directory when running `yarn build` (or `dist-dev` when running `yarn develop`).

			To bump type 5, you would have to run `yarn bump-versions 5`.

Updated Removed version strings from _globals.njk, in favor of src/versions.json. That versions in that file can be bumped with "yarn bump-versions". v1 is automatically bumped when doing "yarn build" as well. Added README file in src directory, explaining versions.json file. Added README file in scripts directory, detailing usage of each scripts. Version strings will no longer be appended when cacheControl is disabled in config file. After all, version strings are only needed when the static assets are cached indefinitely in users' browsers. Initial Cloudflare's cache purging will no longer be executed when cloudflare -> purgeCache is disabled, even if cacheControl is enabled. Just in case someone wants to use version strings for other use cases. Actually use custom metaDesc variable on meta description tag. 2019-09-19 12:10:37 +00:00			`## Cache-Control`

chore: improved some README.md's 2022-06-28 01:17:02 +00:00			Version strings will NOT be used when `cacheControl` in `config.js` is not enabled, since they are only necessary when the assets are being cached indefinitely in browsers.
Updated Added gulp-replace dev dependency. Removed version strings of Fontello fonts from fontello.css Added "build:fontello" Gulp task which will append version string to Fontello fonts, then do the usual processing for CSS file. It will use type 5 from versions.json, if available. Also updated src/README.md about it. 2019-09-19 13:39:23 +00:00
			However, type 5 will still be appended to the built `fontello.css` if it exists in `versions.json` file.