@ms-cloudpack/path-string-parsing 1.0.0

package/CHANGELOG.json

@@ -0,0 +1,20 @@
+{
+  "name": "@ms-cloudpack/path-string-parsing",
+  "entries": [
+    {
+      "date": "Sat, 15 Oct 2022 08:11:07 GMT",
+      "tag": "@ms-cloudpack/path-string-parsing_v1.0.0",
+      "version": "1.0.0",
+      "comments": {
+        "major": [
+          {
+            "author": "dake.3601@gmail.com",
+            "package": "@ms-cloudpack/path-string-parsing",
+            "commit": "962ebd9eb867b159565e221c9f5e800a8eb0ec84",
+            "comment": "Environment agnostic package with slash, parseImportString, and safeRelativePath."
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log - @ms-cloudpack/path-string-parsing
+
+This log was last generated on Sat, 15 Oct 2022 08:11:07 GMT and should not be manually modified.
+
+<!-- Start content -->
+
+## 1.0.0
+
+Sat, 15 Oct 2022 08:11:07 GMT
+
+### Major changes
+
+- Environment agnostic package with slash, parseImportString, and safeRelativePath. (dake.3601@gmail.com)

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { safeRelativePath } from './safeRelativePath.js';
+export { slash } from './slash.js';
+export { parseImportString, type ImportStringResult } from './parseImportString.js';

package/lib/index.js

@@ -0,0 +1,4 @@
+export { safeRelativePath } from './safeRelativePath.js';
+export { slash } from './slash.js';
+export { parseImportString } from './parseImportString.js';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAA2B,MAAM,wBAAwB,CAAC"}

package/lib/parseImportString.d.ts

@@ -0,0 +1,6 @@
+export declare type ImportStringResult = {
+    packageName: string | undefined;
+    version: string | undefined;
+    importPath: string | undefined;
+};
+export declare function parseImportString(importString?: string): ImportStringResult;

package/lib/parseImportString.js

@@ -0,0 +1,10 @@
+import { safeRelativePath } from './safeRelativePath.js';
+export function parseImportString(importString = '') {
+    const matches = importString.match(/[/]?(@[-_a-z-A-Z0-9.]+\/[-_a-z-A-Z0-9.]+|[-_a-zA-Z0-9.]+)(@([-_a-zA-Z-0-9.]+))?(\/([-_/a-zA-Z0-9.]+))?/) || [];
+    return {
+        packageName: matches[1] || '.',
+        version: matches[3] || '',
+        importPath: safeRelativePath(matches[5]),
+    };
+}
+//# sourceMappingURL=parseImportString.js.map

package/lib/parseImportString.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseImportString.js","sourceRoot":"","sources":["../src/parseImportString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAQzD,MAAM,UAAU,iBAAiB,CAAC,YAAY,GAAG,EAAE;IACjD,MAAM,OAAO,GACX,YAAY,CAAC,KAAK,CAChB,wGAAwG,CACzG,IAAI,EAAE,CAAC;IAEV,OAAO;QACL,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG;QAC9B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE;QACzB,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KACzC,CAAC;AACJ,CAAC"}

package/lib/parseImportString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/parseImportString.test.js

@@ -0,0 +1,43 @@
+import { describe, it, expect } from '@jest/globals';
+import { parseImportString } from './parseImportString.js';
+describe(`parseImportString`, () => {
+    it(`can parse a package import`, () => {
+        expect(parseImportString('package')).toEqual({ packageName: 'package', version: '', importPath: '.' });
+    });
+    it(`can parse a package import with a scope`, () => {
+        expect(parseImportString('@scope/package')).toEqual({
+            packageName: '@scope/package',
+            version: '',
+            importPath: '.',
+        });
+    });
+    it(`can parse a package import with a scope and path`, () => {
+        expect(parseImportString('@scope/package/path/to/thing')).toEqual({
+            packageName: '@scope/package',
+            version: '',
+            importPath: './path/to/thing',
+        });
+    });
+    it(`can parse a package import with a scope, version, and path`, () => {
+        expect(parseImportString('@scope/package@1234567890.1234567890.1234567890-abcdeABCDE/path/to/thing')).toEqual({
+            packageName: '@scope/package',
+            version: '1234567890.1234567890.1234567890-abcdeABCDE',
+            importPath: './path/to/thing',
+        });
+    });
+    it(`can handle package names with underscores`, () => {
+        expect(parseImportString('package_name')).toEqual({
+            packageName: 'package_name',
+            version: '',
+            importPath: '.',
+        });
+    });
+    it(`can handle package names with dashes`, () => {
+        expect(parseImportString('package-name')).toEqual({
+            packageName: 'package-name',
+            version: '',
+            importPath: '.',
+        });
+    });
+});
+//# sourceMappingURL=parseImportString.test.js.map

package/lib/parseImportString.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseImportString.test.js","sourceRoot":"","sources":["../src/parseImportString.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE3D,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;IACzG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC;YAClD,WAAW,EAAE,gBAAgB;YAC7B,OAAO,EAAE,EAAE;YACX,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,CAAC,iBAAiB,CAAC,8BAA8B,CAAC,CAAC,CAAC,OAAO,CAAC;YAChE,WAAW,EAAE,gBAAgB;YAC7B,OAAO,EAAE,EAAE;YACX,UAAU,EAAE,iBAAiB;SAC9B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,CAAC,iBAAiB,CAAC,0EAA0E,CAAC,CAAC,CAAC,OAAO,CAAC;YAC5G,WAAW,EAAE,gBAAgB;YAC7B,OAAO,EAAE,6CAA6C;YACtD,UAAU,EAAE,iBAAiB;SAC9B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC;YAChD,WAAW,EAAE,cAAc;YAC3B,OAAO,EAAE,EAAE;YACX,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC;YAChD,WAAW,EAAE,cAAc;YAC3B,OAAO,EAAE,EAAE;YACX,UAAU,EAAE,GAAG;SAChB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/safeRelativePath.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Ensures the give relative path starts with a ./
+ */
+export declare function safeRelativePath(originalPath: string | undefined): string;

package/lib/safeRelativePath.js

@@ -0,0 +1,19 @@
+import { slash } from './slash.js';
+/**
+ * Ensures the give relative path starts with a ./
+ */
+export function safeRelativePath(originalPath) {
+    if (!originalPath || originalPath.length === 0 || originalPath === '.') {
+        return '.';
+    }
+    // Ensure we have the right slashes.
+    originalPath = slash(originalPath);
+    if (originalPath.startsWith('/')) {
+        return '.' + originalPath;
+    }
+    else if (originalPath.startsWith('./')) {
+        return originalPath;
+    }
+    return `./${originalPath}`;
+}
+//# sourceMappingURL=safeRelativePath.js.map

package/lib/safeRelativePath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safeRelativePath.js","sourceRoot":"","sources":["../src/safeRelativePath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,YAAgC;IAC/D,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,KAAK,GAAG,EAAE;QACtE,OAAO,GAAG,CAAC;KACZ;IAED,oCAAoC;IACpC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QAChC,OAAO,GAAG,GAAG,YAAY,CAAC;KAC3B;SAAM,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,KAAK,YAAY,EAAE,CAAC;AAC7B,CAAC"}

package/lib/safeRelativePath.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/safeRelativePath.test.js

@@ -0,0 +1,19 @@
+import { describe, it, expect } from '@jest/globals';
+import { safeRelativePath } from './safeRelativePath.js';
+describe('safeRelativePath', () => {
+    it('can handle default import paths', () => {
+        expect(safeRelativePath(undefined)).toEqual('.');
+        expect(safeRelativePath('')).toEqual('.');
+        expect(safeRelativePath('.')).toEqual('.');
+    });
+    it('can handle an absolute path', () => {
+        expect(safeRelativePath('/foo/bar')).toEqual('./foo/bar');
+    });
+    it('can handle a relative path', () => {
+        expect(safeRelativePath('./foo/bar')).toEqual('./foo/bar');
+    });
+    it('can handle a relative path without a leading slash', () => {
+        expect(safeRelativePath('foo/bar')).toEqual('./foo/bar');
+    });
+});
+//# sourceMappingURL=safeRelativePath.test.js.map

package/lib/safeRelativePath.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"safeRelativePath.test.js","sourceRoot":"","sources":["../src/safeRelativePath.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/slash.d.ts

@@ -0,0 +1 @@
+export declare function slash(str: string): string;

package/lib/slash.js

@@ -0,0 +1,4 @@
+export function slash(str) {
+    return str.replace(/\\/g, '/');
+}
+//# sourceMappingURL=slash.js.map

package/lib/slash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slash.js","sourceRoot":"","sources":["../src/slash.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,KAAK,CAAC,GAAW;IAC/B,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACjC,CAAC"}

package/lib/slash.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/slash.test.js

@@ -0,0 +1,8 @@
+import { describe, it, expect } from '@jest/globals';
+import { slash } from './slash.js';
+describe('slash', () => {
+    it('can reverse slashes', () => {
+        expect(slash('\\asdf\\asdf/asdf')).toEqual('/asdf/asdf/asdf');
+    });
+});
+//# sourceMappingURL=slash.test.js.map

package/lib/slash.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slash.test.js","sourceRoot":"","sources":["../src/slash.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACrD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC7B,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.33.1"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@ms-cloudpack/path-string-parsing",
+  "version": "1.0.0",
+  "description": "Common string parsing of path utilities for the Cloudpack repo.",
+  "license": "MIT",
+  "type": "module",
+  "types": "./lib/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    }
+  },
+  "scripts": {
+    "api:update": "cloudpack-scripts api-update",
+    "api": "cloudpack-scripts api",
+    "build:watch": "cloudpack-scripts build-watch",
+    "build": "cloudpack-scripts build",
+    "lint:update": "cloudpack-scripts lint-update",
+    "lint": "cloudpack-scripts lint",
+    "test:update": "cloudpack-scripts test-update",
+    "test:watch": "cloudpack-scripts test-watch",
+    "test": "cloudpack-scripts test"
+  },
+  "devDependencies": {
+    "@ms-cloudpack/eslint-config-base": "*"
+  },
+  "files": [
+    "/lib"
+  ]
+}