https://github.com/sindresorhus/gulp-chmod

Change permissions of Vinyl files
https://github.com/sindresorhus/gulp-chmod

chmod gulp-plugin javascript nodejs vinyl

Last synced: 2 days ago
JSON representation

Change permissions of Vinyl files

• Host: GitHub
• URL: https://github.com/sindresorhus/gulp-chmod
• Owner: sindresorhus
• License: mit
• Created: 2014-03-07T11:22:03.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2023-10-31T20:47:52.000Z (about 1 year ago)
• Last Synced: 2024-12-25T01:09:24.573Z (9 days ago)
• Topics: chmod, gulp-plugin, javascript, nodejs, vinyl
• Language: JavaScript
• Size: 26.4 KB
• Stars: 39
• Watchers: 8
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

README

        
# gulp-chmod

> [Change permissions](https://en.wikipedia.org/wiki/Chmod) of [Vinyl](https://github.com/gulpjs/vinyl) files

## Install

```sh

npm install --save-dev gulp-chmod

```

## Usage

```js

import gulp from 'gulp';

import chmod from 'gulp-chmod';

export default () => (

	gulp.src('src/app.js')

		.pipe(chmod(0o755))

		.pipe(gulp.dest('dist'))

);

```

or

```js

import gulp from 'gulp';

import chmod from 'gulp-chmod';

export default () => (

	gulp.src('src/app.js')

		.pipe(chmod({

			owner: {

				read: true,

				write: true,

				execute: true

			},

			group: {

				execute: true

			},

			others: {

				execute: true

			}

		}))

		.pipe(gulp.dest('dist'))

);

```

## API

### chmod(fileMode, directoryMode?)

#### fileMode

Type: `number | object`

Can either be a [chmod](https://ss64.com/bash/chmod.html) octal number or an object with the individual permissions specified.

Values depends on the current file, but these are the possible keys:

```js

{

	owner: {

		read: true,

		write: true,

		execute: true

	},

	group: {

		read: true,

		write: true,

		execute: true

	},

	others: {

		read: true,

		write: true,

		execute: true

	}

}

```

When `read`, `write`, and `execute` are the same, you can simplify the object:

```js

{

	read: true

}

```

Pass `undefined` to not set permissions on files. Useful if you only want to set permissions on directories.

#### directoryMode

Type: `true | number | object`

Same as `fileMode`, but applies to directories.

Specify `true` to use the same value as `fileMode`.

## Tip

Combine it with [gulp-filter](https://github.com/sindresorhus/gulp-filter) to only change permissions on a subset of the files.

```js

import gulp from 'gulp';

import chmod from 'gulp-chmod';

import gulpFilter from 'gulp-filter';

const filter = gulpFilter('src/cli.js', {restore: true});

export default = () => (

	gulp.src('src/*.js')

		// Filter a subset of the files

		.pipe(filter)

		// Make them executable

		.pipe(chmod(0o755))

		// Bring back the previously filtered out files

		.pipe(filter.restore)

		.pipe(gulp.dest('dist'))

);

```

## Related

- [gulp-chown](https://github.com/sindresorhus/gulp-chown) - Change owner of Vinyl files