Skip to content

index.md

Latest commit

 

History

History
88 lines (62 loc) · 3.54 KB

index.md

File metadata and controls

88 lines (62 loc) · 3.54 KB

Source Orbit is available as a CLI tool. It can be installed through npm onto most platforms, including IBM i.

General usage

Source Orbit will scan the sources in the current working directory (CWD) and can do a few things:

  • Show object dependencies with -l
  • Generate a different file formats based on the dependency tree to build the project
  • Rename files easily (.rpgle/.clle/.clp -> .pgm.rpgle/.pgm.clle/.clle) with -ar
  • Fix RPGLE includes if the source is found locally (useful for converting from member include style) with -fi
  • List detailed information with --verbose
  • Want to only scan a specific source? Use the -s option: so -s qrpglesrc/employees.pgm.sqlrpgle
cd myibmiproject
so -h
so -bf make && gmake BIN_LIB=libname

Dependency file generation

Source Orbit CLI can generate different file formats using the -bf <type> parameter.

Types available:

  • json Generate all dependency info as JSON
  • bob to generate the required Rules.mk files
  • make generates a single makefile with the targets and rules.
  • imd can be used to generate analysis reports for branches
    • This is particularly useful for pull-requests. It is possible have a pipeline that runs on a push to a branch/PR to generate dependency information.
    • See about GitHub Actions here.
so -bf imd -f `git diff --name-only origin/main origin/${GITHUB_HEAD_REF}`

Specific files

  • You can use -f to make Source Orbit to only care about specific sources. This still scans the entire project, so will know about object parents.
  • Using -s means only a specific files and children of that file/object. This will not scan the entire project.

Cleanup capabilities

The ability to cleanup your source code is usually a one-and-done situation. After you've migrated your source code into git, you may find that a majority of your source extensions are incorrect (like missing the .pgm attribute on your source). There are currently two methods of cleanup available:

  • -ar for auto-rename. This fixes most extensions for your repository. For example, adds the .pgm attribute where possible, changes RPGLE headers to use .rpgleinc and fixes SQL sources to use right extension based on the CREATE statement inside of it.
  • -fi for fix includes. This will scan all RPGLE source code and change the include statements to use the unix style path if the mapped source member can be found in the current working directory.

You can also use --verbose before using those parameters to see impact it will have before running them. To follow up to that, consider using git before using this parameters.

cd myrpgrepo

# Preview warnings and infos
so --verbose

# Fix names
so -ar

# Preview warnings and infos. Will be different since file names changed
so --verbose

# Fix names
so -fi

Installation

We recommend Node.js 18+.

Most platforms

  1. Install Source Orbit globally
    • npm i -g @ibm/sourceorbit
  2. Use so

IBM i

  1. Install Node.js via yum and/or use update-alternatives to set the Node.js version.
    • yum install nodejsxx
    • update-alternatives --set node /QOpenSys/pkgs/lib/nodejs18/bin/node
  2. Install Source Orbit globally on to the IBM i
    • npm i -g @ibm/sourceorbit
  3. Update the PATH environment variable to include the npm binary directory for installed CLI packages
    • PATH=/QOpenSys/pkgs/lib/nodejs18/bin:$PATH
    • put in .bash_profile for CLI usage, put in .bashrc for Code for IBM i usage
  4. Use so