Truffle - How to run Linter command before compile or migrate?

[lalitbit]

I am using truffle with VS Code IDE to build and smart contract. Currently i can run Linter via command (run on console), I am wondering if i can run automate this and run linter command before compile/migrate, and it fails if there is any linter issues.

[Skyge]

Welcome to community!
I think this is depends on how you set for your config of the Linter.

[abcoathup]

Hi @lalitbit welcome.

As per @skyge the answer is it depends.
Some of the potential options are as follows (though @skyge may have a better solution):

You could look at doing linting as part of Continuous Integration.

Test smart contracts like a rockstar

One does not simply test your dapp. Among many other things while developing a decentralized application, testing it is something you always need to do. What most people still don’t do is automate those tests, which leads to a huge loss of time and drains the energy to code. Automated tests have been around for a while and they have been gaining lots of traction in the last decade. Whilst blockchain and smart contract development are fairly new, we can still automate tests for these. We can, s…

I use Juan Blanco's Solidity extension, so that in VS Code I get errors and warnings about my Solidity formatting and then use linting to catch anything I have missed.

VSC extension recommendations

I find Juan Blanco’s extension a must if you are using VSCode for anything Ethereum. Apart from it, I also use: EditorConfig for VS Code and Prettier extensions for code formatting. Mocha sidebar to run tests. Note that this one doesn’t work with Truffle, but I use it for dapps’ code and Buidler tests.

You could add a script to package.json such as the example compile below, which first runs lint and then compiles.

  "scripts": {
    "compile": "npm run lint && truffle compile",
    "coverage": "solidity-coverage && cat coverage/lcov.info | coveralls",
    "lint": "npm run lint:js && npm run lint:sol",
    "lint:fix": "npm run lint:js:fix",
    "lint:js": "eslint .",
    "lint:js:fix": "eslint . --fix",
    "lint:sol": "solhint --max-warnings 0 \"contracts/**/*.sol\"",
    "test": "truffle test"
  },

This is based on the OpenZeppelin package.json scripts.

[abcoathup]

Hi @lalitbit
How did you get on Linting before compiling?

If the above reply solved your issue can you mark it as the solution, otherwise please ask more questions.