majo
Art by でんでん COMIC1・こ 24b
Introduction
You can use majo to manipulate files like a pro, with a simple API whose core is only ≈ 150 SLOC.
Install
yarn add majo
Usage
const { majo } = require ('majo' )
const stream = majo()
stream
.source('js/**' )
.use(ignoreSomeFiles)
.dest('dist' )
.then(() => {
})
function ignoreSomeFiles (stream ) {
for (const filename in stream.files) {
const content = stream.fileContents(filename)
if (/some-string/ .test(content)) {
delete stream.files[filename]
}
}
}
Documentation
https://majo.egoist.sh
Used By
SAO : ⚔️ Futuristic scaffolding tool.
Contributing
Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D
Author
majo © egoist , Released under the MIT License.
Authored and maintained by egoist with help from contributors (list ).
egoist.moe · GitHub @egoist · Twitter @_egoistlily
Type aliases
FilterHandler
FilterHandler: function
Type declaration
( relativePath: string , file: File ) : boolean
Parameters
Returns boolean
Middleware
Middleware: function
Type declaration
( ctx: Majo ) : Promise < void > | void
Parameters
Returns Promise < void >
|
void
OnWrite
OnWrite: function
Type declaration
( relativePath: string , outputPath: string ) : void
Parameters
relativePath: string
outputPath: string
Returns void
TransformHandler
TransformHandler: function
Type declaration
( contents: string ) : Promise < string > | string
Parameters
Returns Promise < string >
|
string
Variables
Const readFile
readFile: __promisify__ = promisify(fs.readFile)
Const remove
remove: function = promisify(rimraf)
Type declaration
( arg1: T1 ) : Promise < void >
Parameters
Returns Promise < void >
Const writeFile
writeFile: __promisify__ = promisify(fs.writeFile)
Functions
Const outputFile
outputFile( filepath: string , data: any , options?: fs.WriteFileOptions ) : Promise < void >
Parameters
filepath: string
data: any
Optional options: fs.WriteFileOptions
Returns Promise < void >
Legend
Module
Object literal
Variable
Function
Function with type parameter
Index signature
Type alias
Type alias with type parameter
Enumeration
Enumeration member
Property
Method
Interface
Interface with type parameter
Constructor
Property
Method
Index signature
Class
Class with type parameter
Constructor
Property
Method
Accessor
Index signature
Inherited constructor
Inherited property
Inherited method
Inherited accessor
Protected property
Protected method
Protected accessor
Private property
Private method
Private accessor
Static property
Static method
Ensure directory exists before writing file