search

superxcgm / xcShell

Your own shell
1 stars 1 forks source link

readme

xcShell - build your own wheel

Coverage Quality Gate Status

KANBAN

Usage

  1. git clone https://github.com/superxcgm/xcShell.git
  2. cd xcShell
  3. ./auto/build.sh
  4. make install
  5. xcShell

Build

./auto/build.sh

Format Your Code

./auto/format.sh

Run

./auto/run.sh

Check Code Style

./auto/lint.sh

Unit Test

./auto/test.sh

Functional Test

Run

./auto/functional_test.sh run

Add a New Test Suite

./auto/functional_test.sh generate xxx
# For example: ./auto/functional_test.sh generate pipe

This command will generate empty file xxx.functional_test.in and xxx.functional_test.expected.out in dir auto/data . And then you can write your test in xxx.functional_test.in, run functional test and check output of you test. It should be located in /tmp/xcShell_functional_test/xxx.functional_test.out.

You can save output by ./auto/functional_test.sh apply xxx if the output file match you expect.

Contribution Guideline

Link