draxt - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #llm #golang #rust #nodejs #java #awesome-list #security #pytorch #ios #openai #open-source

draxt

(★ 186)

draxt.js – NodeList/jQuery-like package for File System (node.js)

파일 탐색기

최종 버전 다운로드 (.zip)

- index.html
- - Directory.js
  - File.js
  - index.js
  - Node.js
  - SymbolicLink.js
- draxt.js
- util.js
- - Directory.js
  - File.js
  - Node.js
  - SymbolicLink.js
- draxt.js
.editorconfig
.eslintrc.js
.gitignore
.prettierrc
.travis.yml
_config.yml
draxt-logo.jpg
draxt-logo.svg
LICENSE
package-lock.json
package.json
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/ramhejazi/draxt

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd draxt

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

$ npm i draxt

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ yarn add draxt

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ npm run test

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center" style="text-align:center">
<a link="https://github.com/ramhejazi/draxt"><img width="300px" style="padding: 20px" alt="draxt.js logo" src="draxt-logo.svg"></a><br>
<a href="https://github.com/ramhejazi/draxt/blob/master/LICENSE"><img alt="draxt license" src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"></a>
<a href="https://www.npmjs.com/package/draxt"><img alt="npm-link" src="https://img.shields.io/npm/v/draxt.svg?style=flat-square"></a>
<a href="https://coveralls.io/github/ramhejazi/draxt"><img alt="draxt coverage status" src="https://img.shields.io/coveralls/github/ramhejazi/draxt.svg?style=flat-square"></a>
</div>
<br>

`draxt` is a utility module for selecting and manipulating filesystem objects in a Node.js environment.
It uses [glob] patterns as its "selector engine". `draxt` also provides several DOM-like interfaces representing filesystem objects which build on promisified APIs for the [`fs`] and [`fs-extra`] modules.

**Example directory structure:**

```
/app/
 ├── controllers/
 │   └── index.js
 ├── public/
 │   ├── script.js
 │   └── style.css
 └── views/
     └── index.html
```

```js
const $ = require('draxt');

(async () => {
    // Select `/app` directory content and create a new `draxt` collection.
    const $app = await $('/app/**');
    $app
        // Let's filter js files:
        .filter((node) => node.extension === 'js')
        // Now we have a new `draxt` collection with 2 nodes.
        .forEach(async (node, index, allNodes) => {
            // `node` is instance of `File` class. Because it's a file!
            console.log(node.pathName);
            // → '/app/controllers/index.js' for the first node!

console.log(node instanceof $.File); // → `true`

// Let's get contents of the node. `file.read` returns a promise object.
            const content = await node.read('utf8');

// Let's use some synchronous methods!
            node.appendSync('\na new line!')
                .chmodSync('765')
                // move the file into another directory!
                .appendToSync('/tmp'); // or `.moveToSync('/tmp')`

console.log(node.pathName);
            // → '/hell/index.js' for the first node in the list!

// get the parent directory of the node.
            // returns a `Directory` instance with the pathName of '/tmp'!
            const parentNode = node.parentSync(); // or `await node.parent()`

// is the directory empty?
            console.log(parentNode.isEmptySync()); // → `false`
        });
})();
```

**Key notes**:

-   `draxt` has only 2 dependencies: [`glob`] and [`fs-extra`] modules.
-   `draxt` uses `glob` patterns to select filesystem objects.
-   Each item in a `draxt` collection is an instance of a [`File`], [`Directory`], or [`SymbolicLink`] class, which is a subclass of [`Node`].
-   Every asynchronous method has a synchronous version. E.g., [`node.siblingsSync()`] for [`node.siblings()`].
-   `draxt` is a simple constructor function. You can extend/overwrite its methods via its `prototype` property (or its `fn` alias) or by using the [`draxt.extend`] method.

```js
const draxt = require('draxt');
// Add a method (`images`) for filtering image files.
draxt.fn.images = function() {
    const imgExtensions = ['jpeg', 'jpg', 'png', 'git', ...];
    return this.filter(node => {
       return node.isFile() && imgExtensions.indexOf(node.extension) > -1;
    });
}
```

## Install

Installing via [npm]:

```bash
$ npm i draxt
```

Via [yarn]:

```bash
$ yarn add draxt
```

## Docs

-   [`draxt` APIs][draxt-doc]
-   Interfaces
    -   [`Node`]
    -   [`File`]
    -   [`Directory`]
    -   [`SymbolicLink`]

## Test

In the past, mock-fs was used for mocking test file system, but since the package is not compatible with
newer versions of node.js, now regular linux cmds like `mkdir` and `echo` are used for creating test files and
folders. The test fs structure are created in `/tmp` directory. That being said, for now, tests only work on Linux!

```bash
$ npm run test
```

## License

[Licensed under MIT.][license]

[repo]: https://github.com/ramhejazi/draxt
[logo]: draxt-logo.jpg
[license]: https://github.com/ramhejazi/draxt/blob/master/LICENSE
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[coverall]: https://coveralls.io/github/ramhejazi/draxt
[coverall-badge]: https://img.shields.io/coveralls/github/ramhejazi/draxt.svg?style=flat-square
[npm-link]: https://www.npmjs.com/package/draxt
[npm-badge]: https://img.shields.io/npm/v/draxt.svg?style=flat-square
[travis-link]: https://travis-ci.org/ramhejazi/draxt
[travis-badge]: https://img.shields.io/travis/ramhejazi/draxt.svg?style=flat-square
[deps-status-link]: https://david-dm.org/ramhejazi/draxt
[deps-status-badge]: https://david-dm.org/ramhejazi/draxt.svg?style=flat-square
[npm]: https://docs.npmjs.com/getting-started/what-is-npm
[yarn]: https://yarnpkg.com/en/
[glob]: https://en.wikipedia.org/wiki/Glob_(programming)
[`fs`]: https://nodejs.org/api/fs.html
[`fs-extra`]: https://github.com/jprichardson/node-fs-extra
[`glob`]: https://github.com/isaacs/node-glob
[Pahlavi language]: https://en.wikipedia.org/wiki/Middle_Persian
[draxt-doc]: https://ramhejazi.github.io/draxt#draxt
[`Node`]: https://ramhejazi.github.io/draxt#interfaces-node
[`File`]: https://ramhejazi.github.io/draxt#interfaces-file
[`Directory`]: https://ramhejazi.github.io/draxt#interfaces-directory
[`SymbolicLink`]: https://ramhejazi.github.io/draxt#interfaces-symboliclink
[`draxt.extend`]: https://ramhejazi.github.io/draxt#draxt-extend
[`node.siblingsSync()`]: https://ramhejazi.github.io/draxt#node-siblings
[`node.siblings()`]: https://ramhejazi.github.io/draxt#node-siblings