@stacksjs/path 0.38.3

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2022 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# Stacks Path
+
+Easily work with file paths.
+
+## ☘️ Features
+
+- Ensures paths are normalized across all Operating Systems
+- Easily access the path's basename, dirname, extension, filename, and more
+- Drop-in Node.js module replacement
+- Written in modern ESM/TypeScript
+
+## 🤖 Usage
+
+```bash
+pnpm i -D @stacksjs/path
+```
+
+Now, you can easily access it in your project:
+
+```js
+import { filename, normalizeAliases, resolve, resolveAlias } from '@stacksjs/path'
+
+// and more...
+```
+
+To view the full documentation, please visit [https://stacksjs.dev/path](https://stacksjs.dev/path).
+
+## 🧪 Testing
+
+```bash
+pnpm test
+```
+
+## 📈 Changelog
+
+Please see our [releases](https://github.com/stacksjs/stacks/releases) page for more information on what has changed recently.
+
+## 💪🏼 Contributing
+
+Please see [CONTRIBUTING](../../.github/CONTRIBUTING.md) for details.
+
+## 🏝 Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Open Web Discord Server](https://discord.ow3.org)
+
+## 🙏🏼 Credits
+
+Many thanks to the following core technologies & people who have contributed to this package:
+
+- [pathe](https://github.com/unjs/pathe)
+- [Chris Breuer](https://github.com/chrisbbreuer)
+- [All Contributors](../../contributors)
+
+## 📄 License
+
+The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
+
+Made with ❤️

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+import { basename, delimiter, dirname, extname, format, isAbsolute, join, normalize, normalizeString, parse, relative, resolve, sep, toNamespacedPath } from 'pathe';
+/**
+ * Returns the path to the `actions` directory. The actions directory
+ * contains the core Stacks' actions. An action
+ *
+ * @param path string - relative path to the file or directory
+ * @returns string - absolute path to the file or directory
+ * @example
+ * ```ts
+ * import { buildPath } from '@stacks/paths'
+ *
+ * buildPath('functions.vue')
+ * buildPath('any-path.ts')
+ * ```
+ */
+export declare function actionsPath(path?: string): any;
+export declare function aliasPath(): any;
+export declare function runtimePath(path?: string): any;
+export declare function arraysPath(path?: string): any;
+export declare function authPath(path?: string): any;
+/**
+ * Returns the path to the build directory. The build directory
+ * contains Stacks' build engine & its tooling integrations.
+ *
+ * @param path string - relative path to the file or directory
+ * @returns string - absolute path to the file or directory
+ * @example
+ * ```ts
+ * buildPath('functions.vue')
+ * buildPath('vue-components.ts')
+ * ```
+ */
+export declare function buildPath(path?: string): any;
+export declare function buildEnginePath(path?: string): any;
+export declare function buildEntriesPath(path?: string): any;
+export declare function cachePath(path?: string): any;
+export declare function cliPath(path?: string): any;
+export declare function collectionsPath(path?: string): any;
+export declare function componentsPath(path?: string): any;
+export declare function configPath(): any;
+export declare function corePath(path?: string): any;
+export declare function docsPath(path?: string): any;
+export declare function customElementsDataPath(): any;
+export declare function errorsPath(path?: string): any;
+export declare function examplesPath(type: 'vue-components' | 'web-components'): any;
+export declare function frameworkPath(path?: string): any;
+export declare function fsPath(path?: string): any;
+export declare function functionsPath(path?: string): any;
+export declare function gitPath(path?: string): any;
+export declare function langPath(path?: string): any;
+export declare function libraryEntryPath(type: 'vue-components' | 'web-components' | 'functions'): any;
+export declare function lintPath(path?: string): any;
+export declare function loggingPath(path?: string): any;
+export declare function modulesPath(path?: string): any;
+export declare function objectsPath(path?: string): any;
+export declare function packageJsonPath(type: 'vue-components' | 'web-components' | 'functions'): any;
+export declare function pagesPath(path?: string): any;
+export declare function pathPath(path?: string): any;
+export declare function projectPath(filePath?: string): any;
+export declare function routerPath(path?: string): any;
+export declare function routesPath(path?: string): any;
+export declare function securityPath(path?: string): any;
+export declare function serverPath(path?: string): any;
+export declare function serverlessPath(path?: string): any;
+export declare function stacksPath(path?: string): any;
+export declare function testsPath(path?: string): any;
+export declare function typesPath(path?: string): any;
+export declare function stringsPath(path?: string): any;
+export declare function scriptsPath(path?: string): any;
+export declare function uiPath(path?: string): any;
+export declare function utilsPath(path?: string): any;
+export declare const path: {
+    actionsPath: typeof actionsPath;
+    aliasPath: typeof aliasPath;
+    arraysPath: typeof arraysPath;
+    authPath: typeof authPath;
+    buildEnginePath: typeof buildEnginePath;
+    buildEntriesPath: typeof buildEntriesPath;
+    buildPath: typeof buildPath;
+    cachePath: typeof cachePath;
+    cliPath: typeof cliPath;
+    collectionsPath: typeof collectionsPath;
+    componentsPath: typeof componentsPath;
+    configPath: typeof configPath;
+    corePath: typeof corePath;
+    customElementsDataPath: typeof customElementsDataPath;
+    docsPath: typeof docsPath;
+    errorsPath: typeof errorsPath;
+    examplesPath: typeof examplesPath;
+    frameworkPath: typeof frameworkPath;
+    fsPath: typeof fsPath;
+    functionsPath: typeof functionsPath;
+    gitPath: typeof gitPath;
+    langPath: typeof langPath;
+    libraryEntryPath: typeof libraryEntryPath;
+    lintPath: typeof lintPath;
+    loggingPath: typeof loggingPath;
+    modulesPath: typeof modulesPath;
+    objectsPath: typeof objectsPath;
+    packageJsonPath: typeof packageJsonPath;
+    pagesPath: typeof pagesPath;
+    pathPath: typeof pathPath;
+    projectPath: typeof projectPath;
+    routerPath: typeof routerPath;
+    routesPath: typeof routesPath;
+    scriptsPath: typeof scriptsPath;
+    securityPath: typeof securityPath;
+    serverPath: typeof serverPath;
+    serverlessPath: typeof serverlessPath;
+    stacksPath: typeof stacksPath;
+    stringsPath: typeof stringsPath;
+    testsPath: typeof testsPath;
+    typesPath: typeof typesPath;
+    uiPath: typeof uiPath;
+    utilsPath: typeof utilsPath;
+    basename: any;
+    delimiter: string;
+    dirname: any;
+    extname: any;
+    format: any;
+    isAbsolute: any;
+    join: any;
+    normalize: any;
+    normalizeString: typeof normalizeString;
+    parse: any;
+    relative: any;
+    resolve: any;
+    sep: string;
+    toNamespacedPath: any;
+};
+export { basename, delimiter, dirname, extname, format, isAbsolute, join, normalize, normalizeString, parse, relative, resolve, sep, toNamespacedPath };
+export default path;

package/dist/index.mjs

@@ -0,0 +1,209 @@
+import { basename, delimiter, dirname, extname, format, isAbsolute, join, normalize, normalizeString, parse, relative, resolve, sep, toNamespacedPath } from "pathe";
+export function actionsPath(path2) {
+  return corePath(`actions/${path2 || ""}`);
+}
+export function aliasPath() {
+  return runtimePath("alias.ts");
+}
+export function runtimePath(path2) {
+  return corePath(`runtime/${path2 || ""}`);
+}
+export function arraysPath(path2) {
+  return corePath(`arrays/${path2 || ""}`);
+}
+export function authPath(path2) {
+  return corePath(`auth/${path2 || ""}`);
+}
+export function buildPath(path2) {
+  return corePath(`build/${path2 || ""}`);
+}
+export function buildEnginePath(path2) {
+  return buildPath(`${path2 || ""}`);
+}
+export function buildEntriesPath(path2) {
+  return buildPath(`entries/${path2 || ""}`);
+}
+export function cachePath(path2) {
+  return corePath(`cache/${path2 || ""}`);
+}
+export function cliPath(path2) {
+  return corePath(`cli/${path2 || ""}`);
+}
+export function collectionsPath(path2) {
+  return corePath(`collections/${path2 || ""}`);
+}
+export function componentsPath(path2) {
+  return projectPath(`components/${path2 || ""}`);
+}
+export function configPath() {
+  return frameworkPath("config.ts");
+}
+export function corePath(path2) {
+  return frameworkPath(`core/${path2 || ""}`);
+}
+export function docsPath(path2) {
+  return corePath(`docs/${path2 || ""}`);
+}
+export function customElementsDataPath() {
+  return frameworkPath("custom-elements.json");
+}
+export function errorsPath(path2) {
+  return corePath(`errors/${path2 || ""}`);
+}
+export function examplesPath(type) {
+  return frameworkPath(`examples/${type || ""}`);
+}
+export function frameworkPath(path2) {
+  return projectPath(`.stacks/${path2 || ""}`);
+}
+export function fsPath(path2) {
+  return corePath(`fs/${path2 || ""}`);
+}
+export function functionsPath(path2) {
+  return projectPath(`functions/${path2 || ""}`);
+}
+export function gitPath(path2) {
+  return corePath(`git/${path2 || ""}`);
+}
+export function langPath(path2) {
+  return projectPath(`lang/${path2 || ""}`);
+}
+export function libraryEntryPath(type) {
+  return buildEntriesPath(`${type}.ts`);
+}
+export function lintPath(path2) {
+  return corePath(`lint/${path2 || ""}`);
+}
+export function loggingPath(path2) {
+  return corePath(`logging/${path2 || ""}`);
+}
+export function modulesPath(path2) {
+  return corePath(`modules/${path2 || ""}`);
+}
+export function objectsPath(path2) {
+  return corePath(`objects/${path2 || ""}`);
+}
+export function packageJsonPath(type) {
+  if (type === "vue-components")
+    return frameworkPath("components/vue/package.json");
+  if (type === "web-components")
+    return frameworkPath("components/web/package.json");
+  if (type === "functions")
+    return frameworkPath("functions/package.json");
+  return frameworkPath(`${type}/package.json`);
+}
+export function pagesPath(path2) {
+  return projectPath(`pages/${path2 || ""}`);
+}
+export function pathPath(path2) {
+  return corePath(`path/${path2 || ""}`);
+}
+export function projectPath(filePath = "") {
+  let path2 = process.cwd();
+  if (path2.includes(".stacks"))
+    path2 = resolve(path2, "..");
+  if (path2.includes(".stacks"))
+    path2 = resolve(path2, "..");
+  if (path2.includes(".stacks"))
+    path2 = resolve(path2, "..");
+  if (!path2.includes(".stacks"))
+    path2 = resolve(path2, ".");
+  return resolve(path2, filePath);
+}
+export function routerPath(path2) {
+  return corePath(`router/${path2 || ""}`);
+}
+export function routesPath(path2) {
+  return projectPath(`routes/${path2 || ""}`);
+}
+export function securityPath(path2) {
+  return corePath(`security/${path2 || ""}`);
+}
+export function serverPath(path2) {
+  return corePath(`server/${path2 || ""}`);
+}
+export function serverlessPath(path2) {
+  return corePath(`serverless/${path2 || ""}`);
+}
+export function stacksPath(path2) {
+  return frameworkPath(`src/${path2 || ""}`);
+}
+export function testsPath(path2) {
+  return corePath(`tests/${path2 || ""}`);
+}
+export function typesPath(path2) {
+  return corePath(`types/${path2 || ""}`);
+}
+export function stringsPath(path2) {
+  return corePath(`strings/${path2 || ""}`);
+}
+export function scriptsPath(path2) {
+  return frameworkPath(`scripts/${path2 || ""}`);
+}
+export function uiPath(path2) {
+  return corePath(`ui/${path2 || ""}`);
+}
+export function utilsPath(path2) {
+  return corePath(`utils/${path2 || ""}`);
+}
+export const path = {
+  actionsPath,
+  aliasPath,
+  arraysPath,
+  authPath,
+  buildEnginePath,
+  buildEntriesPath,
+  buildPath,
+  cachePath,
+  cliPath,
+  collectionsPath,
+  componentsPath,
+  configPath,
+  corePath,
+  customElementsDataPath,
+  docsPath,
+  errorsPath,
+  examplesPath,
+  frameworkPath,
+  fsPath,
+  functionsPath,
+  gitPath,
+  langPath,
+  libraryEntryPath,
+  lintPath,
+  loggingPath,
+  modulesPath,
+  objectsPath,
+  packageJsonPath,
+  pagesPath,
+  pathPath,
+  projectPath,
+  routerPath,
+  routesPath,
+  scriptsPath,
+  securityPath,
+  serverPath,
+  serverlessPath,
+  stacksPath,
+  stringsPath,
+  testsPath,
+  typesPath,
+  uiPath,
+  utilsPath,
+  basename,
+  delimiter,
+  dirname,
+  extname,
+  format,
+  isAbsolute,
+  join,
+  normalize,
+  normalizeString,
+  parse,
+  relative,
+  resolve,
+  sep,
+  toNamespacedPath
+};
+export { basename, delimiter, dirname, extname, format, isAbsolute, join, normalize, normalizeString, parse, relative, resolve, sep, toNamespacedPath };
+export default path;

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@stacksjs/path",
+  "type": "module",
+  "version": "0.38.3",
+  "packageManager": "pnpm@7.15.0",
+  "description": "The Stacks path.",
+  "author": "Chris Breuer",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/chrisbbreuer",
+  "homepage": "https://github.com/stacksjs/stacks/tree/main/.stacks/core/path#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/stacks.git",
+    "directory": "./.stacks/core/path"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/stacks/issues"
+  },
+  "keywords": [
+    "path",
+    "pathe",
+    "paths",
+    "utilities",
+    "functions",
+    "stacks"
+  ],
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "contributors": [
+    "Chris Breuer <chris@ow3.org>"
+  ],
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=v18.12.1",
+    "pnpm": ">=7.15.0"
+  },
+  "dependencies": {
+    "pathe": "^0.3.9"
+  },
+  "devDependencies": {
+    "mkdist": "^0.4.0",
+    "typescript": "^4.8.4"
+  },
+  "scripts": {
+    "build": "mkdist -d",
+    "dev": "mkdist -d",
+    "typecheck": "tsc --noEmit"
+  }
+}