Add toPath() method

Author: WezomDev

src/index.test.ts

@@ -0,0 +1,68 @@
+import toPath from './to-path';
+
+const testCases: {
+	parameters: Parameters<typeof toPath>;
+	result: ReturnType<typeof toPath>;
+}[] = [
+	{
+		parameters: [null],
+		result: []
+	},
+	{
+		parameters: [],
+		result: []
+	},
+	{
+		parameters: [undefined],
+		result: []
+	},
+	{
+		parameters: ['plain.object.helpers'],
+		result: ['plain', 'object', 'helpers']
+	},
+	{
+		parameters: ['plain[object][helpers]'],
+		result: ['plain[object][helpers]']
+	},
+	{
+		parameters: ['plain[1][2][0]object[10][helpers]'],
+		result: ['plain', '1', '2', '0', 'object', '10', '[helpers]']
+	},
+	{
+		parameters: ['plain10]object10]helpers'],
+		result: ['plain10]object10]helpers']
+	},
+	{
+		parameters: ['plain[0]object][helpers]'],
+		result: ['plain', '0', 'object][helpers]']
+	},
+	{
+		parameters: ['.plain..object...helpers.]'],
+		result: ['plain', 'object', 'helpers']
+	},
+	{
+		parameters: ['plain[0]..object[1].helpers]'],
+		result: ['plain', '0', 'object', '1', 'helpers]']
+	},
+	{
+		parameters: ['plain[][][]object[1].helpers'],
+		result: ['plain[][][]object', '1', 'helpers']
+	},
+	{
+		parameters: ['hasOwnProperty'],
+		result: []
+	},
+	{
+		parameters: ['toString'],
+		result: ['toString']
+	}
+];
+
+describe('toPath tool', () => {
+	testCases.forEach(({ parameters, result }, i) => {
+		test(`test #${i + 1}: ${parameters.join(', ')}`, () => {
+			const path = toPath(...parameters);
+			expect(path).toStrictEqual(result);
+		});
+	});
+});

src/index.ts

@@ -0,0 +1,27 @@
+const cache: Record<string, string[]> = {};
+const regex = /(\[(?=\d+])|(?<=\[\d+)])|\.+/;
+
+/**
+ * Convert string sample in to the path (array)
+ * Inspired by final-form's `toPath` helper
+ * {@link https://github.com/final-form/final-form/blob/master/src/structure/toPath.js}
+ * @param {string|null} [sample]
+ * @returns {string[]}
+ */
+export default (sample?: string | null): string[] => {
+	if (typeof sample === 'string' && sample.length > 0 && sample !== 'hasOwnProperty') {
+		if (!cache.hasOwnProperty(sample)) {
+			cache[sample] = sample
+				.split(regex)
+				.filter(
+					(part: string | undefined) =>
+						typeof part === 'string' &&
+						part.length > 0 &&
+						part !== '[' &&
+						part !== ']'
+				);
+		}
+		return cache[sample];
+	}
+	return [];
+};