#JS FORMATTER INSTALL#
This will install a local copy of ESLint and Prettier for the current project using the version defined in package.json. Once npm is available, required packages can be installed running the following command in Openbravo project root:
In order to run the Javascript formatter and linter, it is required to install npm in the development machine. This way they can be autodetected by most IDE plugins. Rules used by ESLint and Prettier can be found in the Openbravo project root: The rule followed for this is to include rules to enforce us to follow good coding practices but without being too disruptive with the current codebase.
#JS FORMATTER UPDATE#
Upgrading the tools is a good opportunity to review and update the linting and formatting rules used in our codebase. This is an opinionated formatter, meaning that it has quite few configuration options, so its likely that it will result in lots of changes when applied in Openbravo codebase. and has a nice support for all newer frontend IDEs (Atom, VSCode). Supports lots of new technologies such as JSX/React, Vue, Angular, Typescript, etc. It is used by people like Facebook (React), Paypal, mongoDB, Discord or yarn. Prettier is a relatively new project which gained a lot of traction (currently having almost 3 million weekly downloads in npm). It is a mature project, and have a large amount of downloads every week, so its still used by the community, but it seems that they're lacking in contributors for the project, and for this reason there are features that are not currently implemented such as JSX support. JS Beautifier could be the obvious choice as it's the one currently used for Openbravo, although we use an old version. For this project it is proposed to migrate from out current linter (JSLint) to the latest version of ESLint, which is 5.13.0, released in February 2019Ī code formatter is a tool that ensures all codebase follows a certain set of rules, making code uniform and easier to maintain.įor this purpose, 3 formatters were considered in this project:ĮSBeautifier formatter can be integrated seamlessly in Openbravo's workflow, but it looks like it has few maintainers and it is not updated quite frequently. This step is removed, and therefore we can remove the dependency of lib/runtime/jslint4java-1.4.7.jar.Ī linter is a tool that analyzes code to detect potential errors, bugs or code style issues. In ComponentGenerator.java, JSLint is invoked when the component to process module is in development, adding an extra overhead to this step. Goals Remove JS code linting after compressing
#JS FORMATTER UPGRADE#
For this reason, an upgrade is required to improve code style and add suppport for new technologies that can potentially be used in the future. that are not supported with our current version of code formatter (JSBeautifier) and linter (JSLint4Java 1.4.7, released in 2011). In the recent years, Javascript has experienced a number of changes, and there are lots of language improvements and technologies availables such as lambda expressions, JSX, React, Typescript, etc. 1.2.3 Replace JS Beautifier with Prettier.1.2.1 Remove JS code linting after compressing.
0 kommentar(er)
