@norescait/noresca-tools v0.2.4

Noresca tools

This package contains tools that improve our day-to-day work.

Background

Typically when working in customization projects we use a set of tools/utilities to make it easier for us to work. These tools are being copied between projects manually and are often outdated, the idea of this package is to make distribution of them easier.

How it works

Installation

Observe that Node JS is a prerequisite

To install the package go to a terminal (in Webstorm or your computer) and run:

npm install -g @norescait/noresca-tools

Available tools

As of right now the following tools are available in the package:

• An update version of the a Noresca-adapted .gitignore file
• An SFTP helper tool
• The SuiteQL Query Tool by Tim Dietrich
• Swagger/OpenAPI Documentation tool
• JSDoc documentation tool

How to use it

The package comes with a set of commands, some commands come with their own flags to give them further instructions, all commands and flags are listed below. All commands start with the noresca-tools package name as so:

 noresca-tools --[command] [flag]  

Help command

 --help

Will list all available commands in the CLI.

Initiate project/files

 --init

To initiate files in a new project, or generate one or multiple new files in an existing project, use the --init command, this will create a folder called NorescaTools in your SuiteScripts directory with the tools you choose to install.

Generate documentation

 --generatedocs

To generate either Swagger/OpenAPI documentation, accepts the following flags:

• types - list all available doc types that can be generated
• swagger - generate swagger documentation
• jsdoc - generate swagger documentation

Example:

 noresca-tools --generatedocs swagger  

Configuration

First things first - after running the init command, if you plan on generating documentation, you should configure the template for Swagger and JSDoc.

For Swagger the file to edit is: ../NorescaTools/swagger/open-api-config.json
For JSDoc the file to edit is: COMING SOON