@stdlib/utils-convert-path

Convert between POSIX and Windows paths.

https://github.com/stdlib-js/utils-convert-path

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

convert javascript linux node node-js nodejs path posix stdlib str string unix util utilities utility utils win win32 windows
Last synced: 4 months ago · JSON representation ·

Repository

Convert between POSIX and Windows paths.

Basic Info
Statistics
  • Stars: 5
  • Watchers: 3
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
convert javascript linux node node-js nodejs path posix stdlib str string unix util utilities utility utils win win32 windows
Created over 4 years ago · Last pushed 5 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Convert Path

NPM version Build Status Coverage Status <!-- dependencies -->

Convert between POSIX and Windows paths.

## Installation ```bash npm install @stdlib/utils-convert-path ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). - To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally. The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage ```javascript var convertPath = require( '@stdlib/utils-convert-path' ); ``` #### convertPath( from, to ) Converts between POSIX and Windows paths. ```javascript var p = convertPath( 'C:\\foo\\bar', 'posix' ); // returns '/c/foo/bar' ``` The following output path conventions are supported: - **win32**: Windows path convention; e.g., `C:\\foo\\bar`. - **mixed**: mixed path convention (Windows volume convention and POSIX path separator); e.g., `C:/foo/bar`. - **posix**: POSIX path convention; e.g., `/c/foo/bar`.
## Notes - A Windows [extended-length path][extended-length-path] **cannot** be converted to either a `mixed` or `posix` path convention, as forward slashes cannot be used as path separators. - If a POSIX path begins with `/[A-Za-z]/` (e.g., `/c/`), the path is assumed to begin with a volume name. - The function makes no attempt to verify that a provided path is valid.
## Examples ```javascript var convertPath = require( '@stdlib/utils-convert-path' ); var p1; var p2; p1 = '/c/foo/bar/beep.c'; p2 = convertPath( p1, 'win32' ); // returns 'c:\foo\bar\beep.c' p1 = '/c/foo/bar/beep.c'; p2 = convertPath( p1, 'mixed' ); // returns 'c:/foo/bar/beep.c' p1 = '/c/foo/bar/beep.c'; p2 = convertPath( p1, 'posix' ); // returns '/c/foo/bar/beep.c' p1 = 'C:\\\\foo\\bar\\beep.c'; p2 = convertPath( p1, 'win32' ); // returns 'C:\\foo\bar\beep.c' p1 = 'C:\\\\foo\\bar\\beep.c'; p2 = convertPath( p1, 'mixed' ); // returns 'C:/foo/bar/beep.c' p1 = 'C:\\\\foo\\bar\\beep.c'; p2 = convertPath( p1, 'posix' ); // returns '/c/foo/bar/beep.c' ```

## CLI
## Installation To use as a general utility, install the CLI package globally ```bash npm install -g @stdlib/utils-convert-path-cli ```
### Usage ```text Usage: convert-path [options] [] --out= Options: -h, --help Print this message. -V, --version Print the package version. -o, --out output Output path convention. --split sep Delimiter for stdin data. Default: '/\\r?\\n/'. ```
### Notes - If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes. ```bash # Not escaped... $ echo -n $'c:/foo/bar\n./docs/eslint' | convert-path --out=posix --split /\r?\n/ # Escaped... $ echo -n $'c:/foo/bar\n./docs/eslint' | convert-path --out=posix --split /\\r?\\n/ ``` - The implementation ignores trailing delimiters.
### Examples ```bash $ convert-path /c/foo/bar --out=mixed c:/foo/bar ``` To use as a [standard stream][standard-streams], ```bash $ echo -n '/c/foo/bar' | convert-path --out=win32 c:\foo\bar ``` By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option. ```bash $ echo -n 'c:/foo/bar\t./docs/eslint' | convert-path --out=win32 --split '\t' c:\foo\bar .\docs\eslint ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

  • Name: stdlib
  • Login: stdlib-js
  • Kind: organization

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total
  • Watch event: 1
  • Push event: 22
Last Year
  • Watch event: 1
  • Push event: 22

Committers

Last synced: 6 months ago

All Time
  • Total Commits: 66
  • Total Committers: 1
  • Avg Commits per committer: 66.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 17
  • Committers: 1
  • Avg Commits per committer: 17.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
stdlib-bot n****y@s****o 66
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • npm 1,662,924 last-month
  • Total docker downloads: 481,308,706
  • Total dependent packages: 5
    (may contain duplicates)
  • Total dependent repositories: 835
    (may contain duplicates)
  • Total versions: 18
  • Total maintainers: 4
npmjs.org: @stdlib/utils-convert-path

Convert between POSIX and Windows paths.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 13
  • Dependent Packages: 5
  • Dependent Repositories: 835
  • Downloads: 1,662,917 Last month
  • Docker Downloads: 481,308,706
Rankings
Docker downloads count: 0.1%
Downloads: 0.1%
Dependent repos count: 0.6%
Dependent packages count: 3.7%
Average: 5.5%
Stargazers count: 13.1%
Forks count: 15.4%
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago
npmjs.org: @stdlib/utils-convert-path-cli

Convert between POSIX and Windows paths.

  • Homepage: https://stdlib.io
  • License: Apache-2.0
  • Latest release: 0.2.2
    published over 1 year ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 7 Last month
Rankings
Stargazers count: 13.6%
Forks count: 15.9%
Average: 30.1%
Dependent repos count: 37.3%
Dependent packages count: 53.5%
Funding
  • type: opencollective
  • url: https://opencollective.com/stdlib
Last synced: 4 months ago

Dependencies

package.json npm
  • @stdlib/assert-is-browser ^0.0.x development
  • @stdlib/assert-is-windows ^0.0.x development
  • @stdlib/bench ^0.0.x development
  • @stdlib/process-exec-path ^0.0.x development
  • istanbul ^0.4.1 development
  • proxyquire ^2.0.0 development
  • tap-spec 5.x.x development
  • tape git+https://github.com/kgryte/tape.git#fix/globby development
  • @stdlib/assert-is-regexp-string ^0.0.x
  • @stdlib/assert-is-string ^0.0.x
  • @stdlib/cli-ctor ^0.0.x
  • @stdlib/fs-read-file ^0.0.x
  • @stdlib/process-read-stdin ^0.0.x
  • @stdlib/regexp-eol ^0.0.x
  • @stdlib/regexp-extended-length-path ^0.0.x
  • @stdlib/streams-node-stdin ^0.0.x
  • @stdlib/string-base-lowercase ^0.0.x
  • @stdlib/string-format ^0.0.x
  • @stdlib/string-replace ^0.0.x
  • @stdlib/utils-regexp-from-string ^0.0.x
.github/workflows/benchmark.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/cancel.yml actions
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/close_pull_requests.yml actions
  • superbrothers/close-pull-request v3 composite
.github/workflows/examples.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/npm_downloads.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/upload-artifact v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/productionize.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • stdlib-js/bundle-action main composite
  • stdlib-js/transform-errors-action main composite
.github/workflows/publish.yml actions
  • JS-DevTools/npm-publish v1 composite
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/test.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/test_bundles.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • denoland/setup-deno v1 composite
.github/workflows/test_coverage.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • codecov/codecov-action v3 composite
  • distributhor/workflow-webhook v3 composite
.github/workflows/test_install.yml actions
  • act10ns/slack v1 composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite