chore: rename filters to snake style, #487

BREAKING CHANGE: keys in `<liquidjs>.filters` are now in snake case (instead of camel case), identical to that in Liquid template.

Author: harttle

.eslintrc.json

@@ -37,6 +37,11 @@
     "@typescript-eslint/no-unused-vars": ["error", { "vars": "all", "args": "none", "ignoreRestSiblings": false }]
   },
   "overrides": [{
+    "files": ["**/filters/*.ts"],
+    "rules": {
+      "camelcase": "off"
+    }
+  }, {
     "files": ["**/*.js", "**/*.mjs"],
     "rules": {
       "@typescript-eslint/no-var-requires": "off"

src/builtin/filters/index.ts

@@ -1,9 +1,9 @@
-import { argumentsToValue, toValue, stringify, caseInsensitiveCompare, isArray, isNil, last as arrayLast, hasOwnProperty } from '../../util/underscore'
-import { toArray } from '../../util/collection'
-import { isTruthy } from '../../render/boolean'
-import { FilterImpl } from '../../template/filter/filter-impl'
-import { Scope } from '../../context/scope'
-import { isComparable } from '../../drop/comparable'
+import { argumentsToValue, toValue, stringify, caseInsensitiveCompare, isArray, isNil, last as arrayLast, hasOwnProperty } from '../util/underscore'
+import { toArray } from '../util/collection'
+import { isTruthy } from '../render/boolean'
+import { FilterImpl } from '../template/filter/filter-impl'
+import { Scope } from '../context/scope'
+import { isComparable } from '../drop/comparable'
 
 export const join = argumentsToValue((v: any[], arg: string) => toArray(v).join(arg === undefined ? ' ' : arg))
 export const last = argumentsToValue((v: any) => isArray(v) ? arrayLast(v) : '')
@@ -25,7 +25,7 @@ export function * sort<T> (this: FilterImpl, arr: T[], property?: string): Itera
   }).map(tuple => tuple[0])
 }
 
-export function sortNatural<T> (input: T[], property?: string) {
+export function sort_natural<T> (input: T[], property?: string) {
   input = toValue(input)
   const propertyString = stringify(property)
   const compare = property === undefined

src/builtin/filters/url.ts

@@ -1,8 +1,8 @@
-import strftime from '../../util/strftime'
-import { LiquidDate } from '../../util/liquid-date'
-import { toValue, stringify, isString, isNumber } from '../../util/underscore'
-import { FilterImpl } from '../../template/filter/filter-impl'
-import { TimezoneDate } from '../../util/timezone-date'
+import strftime from '../util/strftime'
+import { LiquidDate } from '../util/liquid-date'
+import { toValue, stringify, isString, isNumber } from '../util/underscore'
+import { FilterImpl } from '../template/filter/filter-impl'
+import { TimezoneDate } from '../util/timezone-date'
 
 export function date (this: FilterImpl, v: string | Date, format: string, timeZoneOffset?: number) {
   const opts = this.context.opts

src/builtin/filters/array.ts renamed to src/filters/array.ts

@@ -1,4 +1,4 @@
-import { stringify } from '../../util/underscore'
+import { stringify } from '../util/underscore'
 
 const escapeMap = {
   '&': '&',
@@ -23,14 +23,14 @@ function unescape (str: string) {
   return stringify(str).replace(/&(amp|lt|gt|#34|#39);/g, m => unescapeMap[m])
 }
 
-export function escapeOnce (str: string) {
+export function escape_once (str: string) {
   return escape(unescape(stringify(str)))
 }
 
-export function newlineToBr (v: string) {
+export function newline_to_br (v: string) {
   return stringify(v).replace(/\n/g, '<br />\n')
 }
 
-export function stripHtml (v: string) {
+export function strip_html (v: string) {
   return stringify(v).replace(/<script.*?<\/script>|<!--.*?-->|<style.*?<\/style>|<.*?>/g, '')
 }

src/builtin/filters/date.ts renamed to src/filters/date.ts

@@ -0,0 +1,19 @@
+import * as htmlFilters from './html'
+import * as mathFilters from './math'
+import * as urlFilters from './url'
+import * as arrayFilters from './array'
+import * as dateFilters from './date'
+import * as stringFilters from './string'
+import { Default, json } from './misc'
+import { FilterImplOptions } from '../template/filter/filter-impl-options'
+
+export const filters: { [key: string]: FilterImplOptions } = {
+  ...htmlFilters,
+  ...mathFilters,
+  ...urlFilters,
+  ...arrayFilters,
+  ...dateFilters,
+  ...stringFilters,
+  json,
+  default: Default
+}

src/builtin/filters/html.ts renamed to src/filters/html.ts

@@ -1,10 +1,10 @@
-import { toValue, argumentsToValue } from '../../util/underscore'
+import { toValue, argumentsToValue } from '../util/underscore'
 
 export const abs = argumentsToValue(Math.abs)
-export const atLeast = argumentsToValue(Math.max)
-export const atMost = argumentsToValue(Math.min)
+export const at_least = argumentsToValue(Math.max)
+export const at_most = argumentsToValue(Math.min)
 export const ceil = argumentsToValue(Math.ceil)
-export const dividedBy = argumentsToValue((dividend: number, divisor: number, integerArithmetic = false) => integerArithmetic ? Math.floor(dividend / divisor) : dividend / divisor)
+export const divided_by = argumentsToValue((dividend: number, divisor: number, integerArithmetic = false) => integerArithmetic ? Math.floor(dividend / divisor) : dividend / divisor)
 export const floor = argumentsToValue(Math.floor)
 export const minus = argumentsToValue((v: number, arg: number) => v - arg)
 export const modulo = argumentsToValue((v: number, arg: number) => v % arg)

src/filters/index.ts

@@ -1,6 +1,6 @@
-import { isFalsy } from '../../render/boolean'
-import { identify, isArray, isString, toValue } from '../../util/underscore'
-import { FilterImpl } from '../../template/filter/filter-impl'
+import { isFalsy } from '../render/boolean'
+import { identify, isArray, isString, toValue } from '../util/underscore'
+import { FilterImpl } from '../template/filter/filter-impl'
 
 export function Default<T1 extends boolean, T2> (this: FilterImpl, value: T1, defaultValue: T2, ...args: Array<[string, any]>): T1 | T2 {
   value = toValue(value)

src/builtin/filters/math.ts renamed to src/filters/math.ts

@@ -3,8 +3,8 @@
  *
  * * prefer stringify() to String() since `undefined`, `null` should eval ''
  */
-import { escapeRegExp, stringify } from '../../util/underscore'
-import { assert } from '../../util/assert'
+import { escapeRegExp, stringify } from '../util/underscore'
+import { assert } from '../util/assert'
 
 export function append (v: string, arg: string) {
   assert(arguments.length === 2, 'append expect 2 arguments')
@@ -36,7 +36,7 @@ export function remove (v: string, arg: string) {
   return stringify(v).split(String(arg)).join('')
 }
 
-export function removeFirst (v: string, l: string) {
+export function remove_first (v: string, l: string) {
   return stringify(v).replace(String(l), '')
 }
 
@@ -66,7 +66,7 @@ export function strip (v: string, chars?: string) {
   return stringify(v).trim()
 }
 
-export function stripNewlines (v: string) {
+export function strip_newlines (v: string) {
   return stringify(v).replace(/\n/g, '')
 }
 
@@ -79,7 +79,7 @@ export function replace (v: string, pattern: string, replacement: string) {
   return stringify(v).split(String(pattern)).join(replacement)
 }
 
-export function replaceFirst (v: string, arg1: string, arg2: string) {
+export function replace_first (v: string, arg1: string, arg2: string) {
   return stringify(v).replace(String(arg1), arg2)
 }