@open-engx/node v0.1.5

OpenEngX User Guide

OpenEngX is an open source EngX (Engineering Excellence) tool to help you build the project right.

Engineering excellence is usually defined in terms of efficiency and effectiveness in delivering business value and satisfying customer needs. It requires continuous learning, collaboration, and adaptation to emerging technologies and changing customer needs. Software engineers must work together as interdisciplinary teams to formulate solution strategies, foster innovation, and create value for customers and stakeholders.

For details, please refer to this great blog.

Commands

OpenEngX checks your node project.

To run OpenEngX, use:

npx @open-engx/node

This gives you suggestions to achieve engineering excellence.

To get a help, use npx @open-engx/node -h or npx @open-engx/node --help.

TODO

Chore (apply EngX best practices)

• git hooks (husky, lint commit message, and others)
• static code analysis (eslint, prettier, SonarQube or other tools)
• test (unit tests, integration tests, e2e tests)
• CI/CD
• code coverage report
• security analysis (npm-audit, snyk, or other tools)
• observability (logging, error handling, error report, .etc.)
• monorepo (@open-engx/core, @open-engx/node, @open-engx/react, @open-engx/vue, @open-engx/angular, etc.)

Feature (check EngX best practices)

• check git hooks (husky, lint commit message, and others)
• check static code analysis (eslint, prettier, SonarQube or other tools)
• check test (unit tests, integration tests, e2e tests)
• check CI/CD
• check code coverage report
• check security analysis (npm-audit, snyk, or other tools)
• check observability (logging, error handling, error report, .etc.)
• support monorepo projects
• support react/vue/angular projects