How to run and get Solidity Coverage report in Scaffold-Eth? - solidity

I am using Scaffold-eth (https://github.com/scaffold-eth/scaffold-eth).
With that, I can run things like:
yarn test
But I can't run:
yarn coverage
out of the gate (see package.json for all commands).
How can I get a coverage report?

Ok, I found that I had to do this:
Add the following to your package.json file under "scripts":
"coverage": "cd packages/hardhat && npx hardhat coverage --network hardhat"
Then, install Solidity-coverage in your environment:
cd packages/hardhat && yarn workspace #scaffold-eth/hardhat add solidity-coverage --dev
(basically follow these steps: https://github.com/sc-forks/solidity-coverage but in your yarn workspace)
And add the coverage module to your hardhat config file packages/hardhat/hardhat.config.js:
require('solidity-coverage');
That should work.
Now you can run:
yarn coverage from the root folder and a coverage report will appear.

Related

What are the equivalent CI commands for Vue projects based on Vite instead of the Vue CLI?

I created a new Vue project via npm init vue#latest. I used the Vue CLI before and want to get into Vite now. Inside my Github action I used the Vue CLI service commands before but now I'm looking for the equivalent commands using Vite.
Check that the code style is fine (no errors, no warnings)
Inside my workflow I previously used the command
npm run lint -- --no-fix --max-warnings=0
Based on the lint script command
eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore
I added the lint:ci script command
eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --max-warnings 0 --ignore-path .gitignore
Check that unit tests are passing
Inside my workflow I previously used the command
npm run test:unit
Based on the test:unit script command
vitest --environment jsdom
I added the test:unit:ci script command
vitest --environment jsdom --run
Check that e2e tests are passing
Inside my workflow I previously used the command
npm run test:e2e -- --headless
There already is a test:e2e:ci script command and based on the Cypress docs I think I have to use it this way (which worked for me)
- name: Check if e2e tests are passing
uses: cypress-io/github-action#v2
with:
build: npm run build
start: npm run test:e2e:ci
Do you have any better solutions? I'm not sure if this is the most elegant way or if Vue/Vite already provide some commands I don't know about yet.
Thanks in advance!

Missing node_modules bin on PATH

I have run the command
yarn add -D jest to install jest to my project.
This does successfully add jest to my node_modules
> find . -name jest
./node_modules/.bin/jest
./node_modules/jest
When I use iterm2 to run jest however I get the following output
> jest
zsh: command not found: jest
FWIW When I use the IntelliJ terminal it does work
> jest
Determining test suites to run...^C
What am I missing in the iterm environment to be able to have node_modules bin in my classpath depending on the current repo?
An OS shell doesn't know about your locally installed node_modules, but IntelliJ terminal does. So if you want to run jest from outside of an IDE you should perform several additional steps.
The most common way to run locally installed packages is to define a separate script in the "scripts" section of your package.json file. Then you will be able to run it using the yarn/npm itself from any terminal. You can find an exact example in the Yarn docs.
{
"name": "my-package",
"scripts": {
"test": "jest"
}
}
yarn run test
Or you could install jest globally so it will be accessible from anywhere, but it's not a best practice.

When I run cypress as npm run cypress run build fails

I have installed cypress using npm as npm install cypress --save-dev .
I used the same command in .gitlab-ci.yml file
When i run the command npm run cypress run locally , IDE opens and when i double click the spec.js file , then the tests run.
But I i use the same command on the gitlab pipeline , it says
cypress open "run"
It looks like this is your first time using Cypress: 4.1.0
[07:45:16] Verifying Cypress can run /osmc/ux/framework-acceptance-tests/cache/Cypress/4.1.0/Cypress [started]
[07:45:18] Verifying Cypress can run /osmc/ux/framework-acceptance-tests/cache/Cypress/4.1.0/Cypress [completed]
Opening Cypress...
and build fails .
Am i missing anything here ?
It's because it's opening the test runner, which is used locally via npx cypress open.
From that output it looks like you're running npx cypress open run, which isn't a real command and will open the runner
In CI you need to use npx cypress run, which will run tests without user interaction. https://docs.cypress.io/guides/guides/command-line.html#How-to-run-commands
Your gitlab.yml file should accomodate for the npm installations.
One example is as below. Meanwhile also please check the test/run command for your specs under package.json file. use the same command to trigger the test in pipeline.
stages:
- test
test:
image: cypress/browsers:node12.14.1-chrome85
stage: test
script:
npm i
npm run start:ci &
npx cypress run
You should have your .gitlab-ci.yml with:
stages:
- test
cypress-test:
image: cypress/browsers:node16.14.0-slim-chrome99-ff97
stage: test
script:
- npm ci
- npx cypress run

What does " yarn build " command do? Are " npm build " and "yarn build" similar commands?

What does yarn build command do ?
Are yarn build and npm build the same? If not what's the difference?
yarn build and npm build are not existing commands by default. I think you mean yarn run build or npm run build.
build is a command which can be specified in your package.json file on the scripts property. See the example below.
{
"name": "mypackage",
"version": "0.1.0",
"scripts": {
"build": "webpack --config webpack.dev.js"
}
}
In this example, build is a shortcut for launching command webpack --config webpack.dev.js. You can use every keyword you want to define some shortcuts to launch commands.
And the only difference between the two commands it's the JS dependency manager you're using, yarn or npm.
More infos :
https://yarnpkg.com/lang/en/
https://www.npmjs.com/
"yarn build
Bundles the app into static files for production." from Create React App by MAD9135.
https://mad9135.github.io/F2020/modules/week3/02-react-tooling/07-create-react-app.html
yarn build is a shortcut of yarn run build
from original documentation:
Reference: https://classic.yarnpkg.com/lang/en/docs/cli/run/#toc-yarn-run-script
its the same i guess the real difference between yarn and npm is the performance and security that yarn provides.
yarn actually installing packages in parallelly and Npm only install one package at a time
And Yarn have more secure dependency.
Yarn is a package manager for your code. Yarn build makes a bundle of apps in one format and shows errors if the app has any problem that will make an error on the server.

Webpack production build generating no build output and almost no terminal log messages

Im creating my own webpack starter template and in my recent tuning I've somehow stopped the build version from working but I have no idea what's wrong or how to debug it as there no obvious error messages or such.
In my package.json I have:
"scripts": {
"start": "webpack-serve --open --config webpack.dev.js",
"build": "webpack --config webpack.prod.js"
},
My start script runs well. The build Script is not working.
The build script does this in the terminal.
$ npm run build
> webpack-tailwind-starter-template#1.0.0 build /Users/richiekhoo/projects/webpack-tailwind-starter-template
> webpack --config webpack.prod.js
>
> and nothing more...
Debug Attemp #1
Does webpack from the CLI work?
I ran these:
$ webpack
$ webpack -v
$ webpack --version
I didn't get a 'command not found' instead the command executed provided no output and exited.
Is the issue that webpack is not running properly?
I wondered is it enough to have webpack in package.json or do I need it installed globally locally and via npm as a standalone package?
Lost as to how to work out what's wrong. Please help.
Here's the code including my webpack config files:
https://github.com/demingfactor/webpack-tailwind-starter-template
I'm running asdf and it seems there are some issues with how asdf interacts with npm.
I fixed my issue by running these commands (any of them individually could have been the fix).
$ asdf plugin-update --all
$ asdf update
$ npm i npm
I found the solutions here in the last few entries on the thread - https://github.com/asdf-vm/asdf/issues/162