<commit_before># p4-oo [![Build Status](https://travis-ci.org/gcochard/p4-oo.svg)](https://travis-ci.org/gcochard/p4-oo) [![Coverage Status](https://img.shields.io/coveralls/gcochard/p4-oo.svg?style=flat)](https://coveralls.io/r/gcochard/p4-oo)
[![NPM](https://nodei.co/npm/p4-oo.png?compact=true)](https://nodei.co/npm/p4-oo/)

p4-oo is a tiny object-oriented library for dealing with Perforce. Since Perforce sets all files in its workspace as read-only, and expects you to check out any file before editing, automated build processes and whatnot can stumble when trying to write to the file system. This library gives you a simple module to get Perforce out of the way. It saves its state across commands, so you can change working directories and set environment variables, and those will persist for subsequent commands. This is very helpful if you have a centralized system which is running perforce commands on behalf of users.

## Installation
Get the module from NPM
```shell
$ npm install p4-oo --save
```
Include it in your project
```js
var P4 = require("p4-oo");
var p4 = new P4();
```

## API Reference
### p4.edit(path, done)
Tell Perforce to open a file for editing
```js
p4.edit("output.css", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});
```

### p4.add(path, done)
Tell Perforce to add a file to the default pending changelist
```js
p4.add("output.css", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});
```

### p4.smartEdit(path, done)
Start by asking Perforce (nicely) to open a file for editing. If that doesn't work, try adding the file.

This is really meant to be a catch-all for automated output from tools. If you're generating files, there's a good chance that they don't exist yet in the workspace, but they might.

>Note: Since you're sending requests to your Perforce server with each of these commands, don't just run this willy-nilly on every file in your project or something silly like that.

```js
p4.smartEdit("output.css", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});
```

### p4.run(command, [args], done)
Run a command directly, rather than through a proxying function. You can use this to call arbitrary commands, but if you find yourself using this often, feel free to submit a pull request updating the API or an issue describing the command and what you'd like to see returned.

```js
p4.run("edit", "path/to/file", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});

// With optional "args" arg
p4.run("info", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});

// Without optional "args" arg
p4.run("info", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);<commit_msg>fix: readme update (fixes #2)<commit_after># p4-oo [![Build Status](https://travis-ci.org/gcochard/p4-oo.svg)](https://travis-ci.org/gcochard/p4-oo) [![Coverage Status](https://img.shields.io/coveralls/gcochard/p4-oo.svg?style=flat)](https://coveralls.io/r/gcochard/p4-oo)
[![NPM](https://nodei.co/npm/p4-oo.png?compact=true)](https://nodei.co/npm/p4-oo/)

p4-oo is a tiny object-oriented library for dealing with Perforce. Since Perforce sets all files in its workspace as read-only, and expects you to check out any file before editing, automated build processes and whatnot can stumble when trying to write to the file system. This library gives you a simple module to get Perforce out of the way. It saves its state across commands, so you can change working directories and set environment variables, and those will persist for subsequent commands. This is very helpful if you have a centralized system which is running perforce commands on behalf of users.

## Installation
Get the module from NPM
```shell
$ npm install p4-oo --save
```
Include it in your project
```js
var P4 = require("p4-oo");
var p4 = new P4();
```

## API Reference
### p4.edit(path, done)
Tell Perforce to open a file for editing
```js
p4.edit("output.css", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});
```

### p4.add(path, done)
Tell Perforce to add a file to the default pending changelist
```js
p4.add("output.css", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});
```

### p4.smartEdit(path, done)
Start by asking Perforce (nicely) to open a file for editing. If that doesn't work, try adding the file.

This is really meant to be a catch-all for automated output from tools. If you're generating files, there's a good chance that they don't exist yet in the workspace, but they might.

>Note: Since you're sending requests to your Perforce server with each of these commands, don't just run this willy-nilly on every file in your project or something silly like that.

```js
p4.smartEdit("output.css", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});
```

### p4.runCommand(command, [args], done)
Run a command directly, rather than through a proxying function. You can use this to call arbitrary commands, but if you find yourself using this often, feel free to submit a pull request updating the API or an issue describing the command and what you'd like to see returned.

```js
p4.runCommand("edit", "path/to/file", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});

// With optional "args" arg
p4.runCommand("info", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
});

// Without optional "args" arg
p4.runCommand("info", function(err, stdout) {
    if(err) console.error(err.message);
    console.log(stdout);
{'fraction_non_alphanumeric': 0.12491373360938578, 'fraction_numerical': 0.00810904071773637, 'mean_word_length': 4.43298969072165, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '388114', 'n_tokens_mistral': 1831, 'n_tokens_neox': 1761, 'n_words': 685}