https://github.com/timakin/rashomon

Split your code and text in one line.
https://github.com/timakin/rashomon

Last synced: over 1 year ago
JSON representation

Split your code and text in one line.

• Host: GitHub
• URL: https://github.com/timakin/rashomon
• Owner: timakin
• Created: 2015-03-10T07:59:51.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-03-17T04:40:06.000Z (over 11 years ago)
• Last Synced: 2025-01-23T19:19:52.644Z (over 1 year ago)
• Language: JavaScript
• Size: 180 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## Rashomon

Cut code in two.


Rashomon let you split code to comment and code description in one linear.


![978590B696E581I8CB489E6.jpg](https://qiita-image-store.s3.amazonaws.com/0/16301/135862f1-81ac-e832-ff00-ffc974d97025.jpeg "978590B696E581I8CB489E6.jpg")

## Dependencies

- line-reader(^0.2.4)

## Installation

```

npm install rashomon

```

## How to use

Prepare the target code you'd split.


(In this introduction, we use following test.js)

```js:test.js

// this is comment

var Say = "YoHo";

```

Then, you can save comment and code separetely with Rashomon library.

```js:usecase

var path     = require('path');

var Rashomon = require('rashomon');

var target   = path.join(__dirname, './test.js');

var result   = Rashomon.parseCode(target);

console.log(result);

// [{"docsText":"this is comment", "codeText": "var Say = "YoHo";"}]

```