231 lines
5.0 KiB
Markdown
231 lines
5.0 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# cwd
|
|
|
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
|
|
> Return the current working directory.
|
|
|
|
<section class="installation">
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @stdlib/process-cwd
|
|
```
|
|
|
|
</section>
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var cwd = require( '@stdlib/process-cwd' );
|
|
```
|
|
|
|
#### cwd()
|
|
|
|
Returns the current working directory.
|
|
|
|
```javascript
|
|
var dir = cwd();
|
|
// e.g., returns '/path/to/current/working/directory'
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="notes">
|
|
|
|
## Notes
|
|
|
|
- In browser environments, the current working directory is always equal to `'/'`.
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var PATH_SEP = require( '@stdlib/constants-path-sep' );
|
|
var cwd = require( '@stdlib/process-cwd' );
|
|
|
|
var parts = cwd().split( PATH_SEP );
|
|
console.log( parts );
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
* * *
|
|
|
|
<section class="cli">
|
|
|
|
## CLI
|
|
|
|
<section class="installation">
|
|
|
|
## Installation
|
|
|
|
To use the module as a general utility, install the module globally
|
|
|
|
```bash
|
|
npm install -g @stdlib/process-cwd
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- CLI usage documentation. -->
|
|
|
|
<section class="usage">
|
|
|
|
### Usage
|
|
|
|
```text
|
|
Usage: cwd [options]
|
|
|
|
Options:
|
|
|
|
-h, --help Print this message.
|
|
-V, --version Print the package version.
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<section class="examples">
|
|
|
|
### Examples
|
|
|
|
```bash
|
|
$ cwd
|
|
/path/to/current/working/directory
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
</section>
|
|
|
|
<!-- /.cli -->
|
|
|
|
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
|
|
|
|
<section class="related">
|
|
|
|
* * *
|
|
|
|
## See Also
|
|
|
|
- <span class="package-name">[`@stdlib/process/chdir`][@stdlib/process/chdir]</span><span class="delimiter">: </span><span class="description">change the current working directory.</span>
|
|
|
|
</section>
|
|
|
|
<!-- /.related -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
|
|
<section class="main-repo" >
|
|
|
|
* * *
|
|
|
|
## 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-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
|
</section>
|
|
|
|
<!-- /.stdlib -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/process-cwd.svg
|
|
[npm-url]: https://npmjs.org/package/@stdlib/process-cwd
|
|
|
|
[test-image]: https://github.com/stdlib-js/process-cwd/actions/workflows/test.yml/badge.svg
|
|
[test-url]: https://github.com/stdlib-js/process-cwd/actions/workflows/test.yml
|
|
|
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/process-cwd/main.svg
|
|
[coverage-url]: https://codecov.io/github/stdlib-js/process-cwd?branch=main
|
|
|
|
<!--
|
|
|
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/process-cwd.svg
|
|
[dependencies-url]: https://david-dm.org/stdlib-js/process-cwd/main
|
|
|
|
-->
|
|
|
|
[umd]: https://github.com/umdjs/umd
|
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
|
|
[deno-url]: https://github.com/stdlib-js/process-cwd/tree/deno
|
|
[umd-url]: https://github.com/stdlib-js/process-cwd/tree/umd
|
|
[esm-url]: https://github.com/stdlib-js/process-cwd/tree/esm
|
|
|
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
[chat-url]: https://gitter.im/stdlib-js/stdlib/
|
|
|
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
|
|
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
|
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/process-cwd/main/LICENSE
|
|
|
|
<!-- <related-links> -->
|
|
|
|
[@stdlib/process/chdir]: https://www.npmjs.com/package/@stdlib/process-chdir
|
|
|
|
<!-- </related-links> -->
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|