https://github.com/l2silver/pagitter
An advanced file generator
https://github.com/l2silver/pagitter
Last synced: 6 months ago
JSON representation
An advanced file generator
- Host: GitHub
- URL: https://github.com/l2silver/pagitter
- Owner: l2silver
- License: mit
- Created: 2016-02-04T01:33:49.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-03-04T03:01:23.000Z (over 10 years ago)
- Last Synced: 2025-01-29T23:11:40.190Z (over 1 year ago)
- Language: JavaScript
- Size: 4.01 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pagitter
The lightweight file generator designed to facilitate application development.
[](https://travis-ci.org/l2silver/pagitter)
### Examples
*home/yourProject/pagitter.js*
````
/*_ example.js */
()=>{
console.log('hello')
}
````
````
$ pgt
````
--->
*home/yourProject/example.js*
````
()=>{
console.log('hello')
}
````
````
$ pgt --watch
````
*home/yourProject/pagitter.js*
````
/*_ example.js */
()=>{
console.log('After running pgt with a watch option,
anytime the pagitter file is saved, the files will be regenerated')
}
````
--->
*home/yourProject/example.js*
````
()=>{
console.log('After running pgt with a watch option,
anytime the pagitter file is saved, the files will be regenerated')
}
````
*home/yourProject/pagitter.js*
````
/*_ example.js */
()=>{
console.log('Call s declared in the code section')
}
/*_ example2.js */
()=>{
console.log('Once a is declared,
all codes downstream in the pagitter file will have access to it,
unless it is overwritten')
}
/*_ @callWhat@/example.js */
()=>{
console.log('Variables can also be called in the
code section by wrapping them in @ symbols')
}
/*_ example@3@.js */
()=>{
console.log('variables will be evaluated if they start with ^^')
}
````
### Setup
Create a config file called `pgt.config.js`
This file will hold the plugins to be used with pagitter.
*Example pgt.config.js*
````
{
"plugins": [
"pagitter-write"
, "pagitter-store"
]
}
````
Then create your first pagitter.js file in the root directory
````
/*_ example.js */
````
And run `$ pgt` to output the file
### Stores
Pagitter comes with the store plugin which allows you to create stores
*home/yourProject/pagitter.js*
````
/*_ example.js */
()=>{
console.log('this creates a store file in the .pagitter folder in the root directory')
console.log('starting from when the store is created
, all of the following code and content will be saves to the store')
}
````
After you save a store, you can access it by running the following command
````
$pgt --reverse storeName
````
We use the reverse option because before the store is thrown into the pagitter file, because it looks through all of the wouldbe files in the store, and records their content. That way, a user can make regular changes to the content, and still use pagitter to update files without worrying about overwriting new content.
### Delete Files
Pagitter comes with a delete plugin that allows users to delete all of the filenames in the pagitter.js document. This is useful for quickly changing the names of a group of files that share a similar name component.
*For Example*
Suppose you had:
userController.js
userModel.js
userView.js
which you wanted to change to:
personController.js
personModel.js
personView.js
*home/yourProject/pagitter.js*
````
/*_ @baseName@Controller.js */
...
/*_ @baseName@Model.js */
...
/*_ @baseName@View.js */
...
````
````
$pgt --d
````
--->Deletes userController.js, userModel.js, userView.js
*home/yourProject/pagitter.js*
````
/*_ @baseName@Controller.js */
...
/*_ @baseName@Model.js */
...
/*_ @baseName@View.js */
...
````
--->Writes personController.js, personModel.js, personView.js