refactor: rename prepend to prefill for clarification

Author: RonaldJerez

src/component.vue

@@ -57,10 +57,10 @@ export default {
       default: false
     },
     /**
-     * If the mask starts with static characters, show them in the field initially before typing anything.
-     * @since v1.3
+     * If the mask value starts with static charaters, prefill it with the static charecters at load. 
+\     * @since v1.3
      */
-    prepend: {
+    prefill: {
       type: Boolean,
       default: false
     },
@@ -106,7 +106,7 @@ export default {
         mask: this.mask,
         tokens: this.tokens,
         formatter: this.formatter,
-        prepend: this.prepend
+        prefill: this.prefill
       }
     },
     emittedValue() {

src/masker.js

@@ -53,15 +53,14 @@ export function dynamic(inputValue, config) {
  * Formats the value based on the given masking rule
  *
  * @param {string} value the value to mask
- * @param {{mask: String, tokens: Object, prepend: Boolean}} config
  * @param {object} config
  * @param {string} config.mask the masking string
  * @param {object} config.tokens the tokens to add/override to the global
- * @param {boolean} config.prepend whether or not to add masking characters to the input before the user types.
+ * @param {boolean} config.prefill whether or not to add masking characters to the input before the user types
  * @param {boolean} config.short to keep the string as short as possible (not append extra chars at the end)
  */
 export function formatter(value, config) {
-  let { mask = '', tokens, prepend = false, short = false } = config
+  let { mask = '', tokens, prefill = false, short = false } = config
 
   // append/override global tokens instead of complete override
   tokens = tokens ? Object.assign({}, tokenDefinitions, tokens) : tokenDefinitions
@@ -108,8 +107,8 @@ export function formatter(value, config) {
   }
 
   // if there is no unmasked value, set masked to empty to avoid showing masking
-  // characters in an otherwise empty input, unless prepend is set ot true
-  if ((prepend && !output.unmasked) || (!short && output.unmasked)) {
+  // characters in an otherwise empty input, unless prefill is set ot true
+  if ((prefill && !output.unmasked) || (!short && output.unmasked)) {
     output.masked += accumulator
   }
 

tests/directive.test.js

@@ -87,8 +87,8 @@ describe('Directive', () => {
       expect(wrapper.element.unmaskedValue).toBe('1234')
     })
 
-    test('Should honor prepend modifier', async () => {
-      buildWrapper({ modifiers: 'prepend', mask: '+1 ###', value: '' })
+    test('Should honor prefill modifier', async () => {
+      buildWrapper({ modifiers: 'prefill', mask: '+1 ###', value: '' })
       expect(wrapper.element.value).toBe('+1 ')
 
       wrapper.element.value = '777'

tests/formatter.test.js

@@ -58,5 +58,5 @@ test('2 -> +1 # 5', () => {
 })
 
 test('empty -> +1 # 5', () => {
-  expect(formatter('', { mask: '+1 # 5', prepend: true })).toMatchObject({ masked: '+1 ', unmasked: '' })
+  expect(formatter('', { mask: '+1 # 5', prefill: true })).toMatchObject({ masked: '+1 ', unmasked: '' })
 })