Add parsePath() and serializePath()

src/config/normalize/lib/modify.js

@@ -2,7 +2,7 @@ import { callValueFunc, callUserFunc, getValidateExampleError } from './call.js'
 import { resolvePath } from './path.js'
 import { transformValue } from './transform.js'
 import { getWarnings } from './warn.js'
-import { has, parse } from './wild_wild_path/main.js'
+import { has, parsePath } from './wild_wild_path/main.js'
 
 // Once the initial value has been computed, apply validation and transforms,
 // unless the value is `undefined`.
@@ -69,6 +69,6 @@ const renameProp = async function (value, rename, opts) {
     return
   }
 
-  const renamedPath = parse(renameReturn)
+  const renamedPath = parsePath(renameReturn)
   return has(opts.funcOpts.config, renamedPath) ? undefined : renamedPath
 }

src/config/normalize/lib/opts.js

@@ -2,7 +2,7 @@ import { callUserFunc } from './call.js'
 import { getCwd } from './cwd.js'
 import { applyMoves } from './move.js'
 import { getPrefix, DEFAULT_PREFIX } from './prefix.js'
-import { parse, serialize } from './wild_wild_path/main.js'
+import { parsePath, serializePath } from './wild_wild_path/main.js'
 
 // Retrieve `opts` passed to most methods.
 // `funcOpts` are passed to user-provided functions.
@@ -18,7 +18,7 @@ export const getOpts = async function ({
   moves,
 }) {
   const originalPath = applyMoves(moves, namePath)
-  const originalName = serialize(originalPath)
+  const originalName = serializePath(originalPath)
   const funcOpts = {
     name: nameQuery,
     path: namePath,
@@ -43,7 +43,7 @@ export const getOpts = async function ({
 // `funcOpts.config`.
 const computeParent = async function (opts, moves, parent) {
   const originalPath = await appendParentToName(parent, opts)
-  const originalName = serialize(originalPath)
+  const originalName = serializePath(originalPath)
   return { ...opts, funcOpts: { ...opts.funcOpts, originalName, originalPath } }
 }
 
@@ -53,7 +53,7 @@ const computeParent = async function (opts, moves, parent) {
 // By default, there are none.
 const appendParentToName = async function (parent, opts) {
   const parentA = await callUserFunc(parent, opts)
-  const parentPath = parse(parentA)
+  const parentPath = parsePath(parentA)
   return [...parentPath, ...opts.funcOpts.originalPath]
 }
 

src/config/normalize/lib/rule.js

@@ -1,4 +1,4 @@
-import { get, parse, serialize } from './wild_wild_path/main.js'
+import { get, parseQuery, serializeQuery } from './wild_wild_path/main.js'
 
 // Validate and normalize rules.
 // All methods and properties that use queries can use either the string or the
@@ -8,8 +8,8 @@ export const normalizeRules = function (rules) {
 }
 
 const parseName = function ({ name, ...rule }) {
-  const nameQuery = serialize(name)
-  const namePath = parse(name)
+  const nameQuery = serializeQuery(name)
+  const namePath = parseQuery(name)
   return { ...rule, nameQuery, namePath }
 }
 

src/config/normalize/lib/transform.js

@@ -2,7 +2,7 @@ import isPlainObj from 'is-plain-obj'
 import pReduce from 'p-reduce'
 
 import { callValueFunc } from './call.js'
-import { parse } from './wild_wild_path/main.js'
+import { parsePath } from './wild_wild_path/main.js'
 
 // Apply `transform(value, opts)` which transforms the value set by the user.
 // If can also delete it by returning `undefined`.
@@ -58,7 +58,7 @@ const isTransformMove = function (transformReturn) {
 }
 
 const getTransformMove = function ({ value, newProp }) {
-  const newPropA = parse(newProp)
+  const newPropA = parsePath(newProp)
   return newPropA.length === 0 ? {} : { value, newProp: newPropA }
 }
 

src/config/normalize/lib/wild_wild_path/iterate/main.js

@@ -1,6 +1,6 @@
 import { groupBy } from '../../../../../utils/group.js'
-import { parse } from '../parsing/parse.js'
-import { serialize } from '../parsing/serialize.js'
+import { parseQuery } from '../parsing/parse.js'
+import { serializePath } from '../parsing/serialize.js'
 
 import { removeDuplicates } from './duplicate.js'
 import { expandToken } from './expand.js'
@@ -11,7 +11,7 @@ import { expandToken } from './expand.js'
 //  - To allow consumers to return only the first matching entry quickly
 //  - To keep memory consumption low even on big queries
 export const iterate = function* (target, query, { childFirst = false } = {}) {
-  const queryArrays = parse(query)
+  const queryArrays = parseQuery(query)
   const entries = queryArrays.map((queryArray) => ({
     queryArray,
     value: target,
@@ -43,7 +43,7 @@ const getParentEntries = function (entries, index) {
 }
 
 const normalizeEntry = function ({ value, path, missing }) {
-  const query = serialize(path)
+  const query = serializePath(path)
   return { value, path, query, missing }
 }
 

src/config/normalize/lib/wild_wild_path/main.js

@@ -6,7 +6,7 @@ export {
   isSameToken,
   isParentPath,
 } from './parsing/compare.js'
-export { serialize, serializePath } from './parsing/serialize.js'
-export { parse, parsePath } from './parsing/parse.js'
+export { serializeQuery, serializePath } from './parsing/serialize.js'
+export { parseQuery, parsePath } from './parsing/parse.js'
 export { remove } from './remove.js'
 export { set } from './set.js'

src/config/normalize/lib/wild_wild_path/parsing/compare.js

@@ -1,16 +1,16 @@
 import { getObjectTokenType } from '../tokens/main.js'
 
 import { validatePath } from './normalize.js'
-import { parse } from './parse.js'
+import { parseQuery } from './parse.js'
 
 // Check if two queries are equal.
 // Works with:
 //  - Normalization, e.g. `:` === `0:`
 //  - Unions, e.g. `a b` === `b a`
 //  - Duplicates, e.g. `a a` === `a`
 export const isSameQuery = function (queryA, queryB) {
-  const queryArraysA = parse(queryA)
-  const queryArraysB = parse(queryB)
+  const queryArraysA = parseQuery(queryA)
+  const queryArraysB = parseQuery(queryB)
   return (
     queryArraysA.length === queryArraysB.length &&
     queryArraysA.every((queryArrayA) =>

src/config/normalize/lib/wild_wild_path/parsing/parse.js

@@ -81,12 +81,14 @@ import { parseQueryString } from './query.js'
 // Exceptions are thrown on syntax errors:
 //  - I.e. query or path syntax errors, or wrong arguments
 //  - But queries matching nothing do not throw: instead they return nothing
+// Parse a path
 export const parsePath = function (query) {
-  const queryArrays = parse(query)
+  const queryArrays = parseQuery(query)
   return normalizePath(queryArrays)
 }
 
-export const parse = function (query) {
+// Parse a query string or array
+export const parseQuery = function (query) {
   return isQueryString(query)
     ? safeParseQueryString(query)
     : normalizeQueryArrays(query)

src/config/normalize/lib/wild_wild_path/parsing/serialize.js

@@ -1,13 +1,13 @@
 import { TOKEN_SEPARATOR, ARRAY_SEPARATOR } from '../tokens/escape.js'
 import { getObjectTokenType } from '../tokens/main.js'
 
-import { parse, parsePath } from './parse.js'
+import { parseQuery, parsePath } from './parse.js'
 
-// Inverse of `parse()`
+// Inverse of `parseQuery()`
 // When passing a query string, it is parsed and re-serialized to validate and
 // normalize it.
-export const serialize = function (query) {
-  const queryArrays = parse(query)
+export const serializeQuery = function (query) {
+  const queryArrays = parseQuery(query)
   return queryArrays.map(serializeQueryArray).join(ARRAY_SEPARATOR)
 }