shinka-cli

A command line tool for developing MyBB plugins.

Installation

Yarn

yarn global add shinka-cli

NPM

npm install --global shinka-cli

Configure

Create the utility's config file in the root of your app. See Configure for more information.

`shinka.json`

{
    "link": {
        "files": ["inc/plugins/shinka.php"],
        "directories": ["inc/plugins/Shinka"]
    },
    "mybb_root": "C:/path/to/mybb/root"
}

Configure

Create the utility's config file in the root of your app. See shinka.example.json for a full example.

`shinka.json`

{
    "link": {
        "files": ["inc/plugins/shinka.php"],
        "directories": ["inc/plugins/Shinka"]
    },
    "mybb_root": "C:/path/to/mybb/root",
    "vendor": "shinka",
    "code": "cli",
    "version": "0.0.1-a"
}

Fields

link: files and directories used by the link, unlink, and relink commands.

mybb_root: Root directory of your local MyBB installation. Used by the link, unlink, and relink commands.

vendor: Vendor name, e.g. shinka in shinka-cli. Used by the release command.

code: Plugin codename, e.g. cli in shinka-cli. Used by the release command.

version: Semantic plugin version. Used by the release command.

Usage

Try shinka <command> --help for detailed options and examples.

`link`

Create symbolic links for plugin files and directories.

Options

-v, --verbose: Output verbose error messages

Examples

$ link 
$ link --verbose
$ link -v

`relink`

Destroy and recreate symbolic links for plugin files and directories.

Options

-v, --verbose: Output verbose error messages

Examples

$ relink 
$ relink --verbose
$ relink -v

`unlink`

Destroy and recreate symbolic links for plugin files and directories.

Options

-v, --verbose: Output verbose error messages

Examples

$ unlink 
$ unlink --verbose
$ unlink -v

`release`

Create symbolic links for plugin files and directories.

Options

-v, --verbose: Output verbose error messages

-s, --semver [version]: Plugin version. Defaults to shinka.json.

-N, --vendor [vendor]: Vendor name, e.g. shinka in shinka-cli. Defaults to shinka.json.

-c, --code [code]: Plugin codename, e.g. cli in shinka-cli. Defaults to shinka.json.

-o, --output [path]: Bundle filename. Should include file extension.

-d, --directory [path]: Output directory and filename. Should include file extension.

Examples

$ release      # Outputs to shinka-cli-0.0.1a.zip
$ release -N shin -c news -s 1.0.0     # Outputs to shin-news-1.0.0.zip
$ release -o to/a/path/release.zip     # Outputs to to/a/path/release.zip
$ release -d to/a/path     # Outputs to to/a/path/shinka-cli-0.0.1a.zip

Contributing

Code of Conduct

Please note that this project is released with a Contributor Covenant Code of Conduct. By participating in this project you agree to abide by its terms.

Standards

New features must have tests
Branching model loosely follows Git Flow
All contributions should branch off of develop and all PRs should merge back into develop
Prefix branch names with bugfix/ or feature/ as appropriate, e.g. feature/test-command

Setup

git clone https://github.com/ShinkaDev-MyBB/cli.git
cd cli
yarn install # or npm install

# Run project
node dist/bin/shinka.js --help

# Run tests
yarn test
yarn test --watch

# Generate docs/
yarn docs

# Build for release
yarn build

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

Using welcoming and inclusive language
Being respectful of differing viewpoints and experiences
Gracefully accepting constructive criticism
Focusing on what is best for the community
Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

The use of sexualized language or imagery and unwelcome sexual attention or advances
Trolling, insulting/derogatory comments, and personal or political attacks
Public or private harassment
Publishing others' private information, such as a physical or electronic address, without explicit permission
Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at kalyndrobinson@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html