Skip to content
Development Toolbox for AdonisJs providers
TypeScript JavaScript
Branch: develop
Clone or download
Latest commit b6ddf26 Aug 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github docs: fix contributing link in pr template Aug 15, 2019
src feat: add async api to commit package file Aug 18, 2019
test feat: add async api to commit package file Aug 18, 2019
.editorconfig feat: rewrite from scratch Jul 14, 2019
.gitignore feat: rewrite from scratch Jul 14, 2019
.npmrc
CONTRIBUTING.md feat: rewrite from scratch Jul 14, 2019
LICENSE.md feat: rewrite from scratch Jul 14, 2019
README.md chore(tsconfig): skip lib check, since mrm-core is failing Jul 14, 2019
config.json feat: rewrite from scratch Jul 14, 2019
exports.ts feat: export kleur Aug 19, 2019
index.ts feat: add helper to execute instructions from a given package Jul 18, 2019
japaFile.js refactor: disabling inline log statements Aug 18, 2019
package.json chore(release): 2.1.2 Aug 19, 2019
tsconfig.json feat: add helper to execute instructions from a given package Jul 18, 2019
tslint.json feat: rewrite from scratch Jul 14, 2019

README.md

@adonisjs/sink

A collection of utilities for creating AdonisJs packages and boilerplates.

circleci-image npm-image license-image

AdonisJs sink is a collection of file utilities to mutate the contents of a file with support for partial updates, automatic commits and rollbacks.

Table of contents

Usage

Install the package from npm as follows:

npm i @adonisjs/sink

# Yarn
yarn add @adonisjs/sink

and then use it as follows:

import { PackageFile } from '@adonisjs/sink'

const pkg = new PackageFile(process.cwd())

pkg.setScript('build', 'tsc')
pkg.install(['typescript', 'tslint'])

pkg.commit()

You will use this package when creating your own boilerplates for AdonisJs or when you want to run instructions using instructions.ts file.

In both the places, you will get the basePath of the application from AdonisJs itself.

Maintainers

Harminder virk

You can’t perform that action at this time.