Javascript (JS) Guidelines

This section describes requirements and guidelines for the installation and development of JavaScript and TypeScript applications for use within the SKAO.

Note

TypeScript

TypeScript is a super-set of JavaScript. Its usage is implied and so is not specifically mentioned unless required.

• Prerequisites
  • Account on gitlab
  • Access to the SKA gitlab account
  • Access to git
  • Access to node
  • Access to a package manager
• Creating a new repository for JS applications
  • Application template repository
  • Migrating the template for a new application
  • SKAO Libraries
• Repository layout and dependencies
  • Repository structure
  • Packaging & Dependencies
  • Checking for dependency/security issues
  • Checking for dependency updates
• Coding Style
  • Conventions
  • Use of TypeScript
  • File Suffixes
  • Data and Configuration Files
  • Logging implementation
  • Accessibility
  • Testing
• Code format and layout
  • Prettier
  • ESLint
  • code-analysis
  • code-coverage
• Testing
  • What is unit testing?
  • What is component testing?
  • Unit/Component testing in the SKAO
  • end-to-end ( e2e ) testing
  • Using the testId property
• Documentation
  • README.md
  • Read-the-docs
  • JSDocs