Skip to content

fix/Migrate to ESM #5 #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Abeeujah merged 1 commit into from
Jun 3, 2025
Merged

fix/Migrate to ESM #5 #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 49 additions & 3 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


# Contributing to SkillNet: Empowering Exams with Innovation

Thank you for your interest in contributing to SkillNet! SkillNet is a cutting-edge platform designed to host secure and efficient online exams. Our backend is built with Node.js and utilizes modern technologies to deliver a seamless testing experience for educators and candidates.
Expand Down Expand Up @@ -338,4 +336,52 @@ Please adhere to our Code of Conduct to maintain a respectful and inclusive comm
- Document new features and updates thoroughly.

## License
This project is licensed under the MIT License - see the LICENSE file for details.
This project is licensed under the MIT License - see the LICENSE file for details.

## ESM Migration Guide and Test Fixes

### 1. Update Configuration Files

#### `package.json`:
```json
{
"type": "module",
"scripts": {
"test": "NODE_OPTIONS=--experimental-vm-modules jest",
"dev": "nodemon src/server.js",
"start": "node src/server.js"
},
"jest": {
"transform": {},
"extensionsToTreatAsEsm": [".js"]
}
}
```

#### `jest.config.js`:
```javascript
export default {
testEnvironment: 'node',
transform: {},
extensionsToTreatAsEsm: ['.js'],
moduleNameMapper: {
'^(\\.{1,2}/.*)\\.js$': '$1'
}
};
```

### 2. Common Issues and Solutions

| Issue | Solution |
|-------------------------------|------------------------------------|
| "Cannot use import statement" | Ensure "type": "module" is set |
| Mock not working in tests | Use unstable_mockModule for ESM |
| Missing file extensions | Always include .js in imports |
| Async test failures | Add proper await/async handling |

## ESM Usage

```javascript
// Importing from this package
import { createExam } from 'skillnet-exam-server'
```
3 changes: 3 additions & 0 deletions babel.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default {
presets: [['@babel/preset-env', { targets: { node: 'current' } }]],
};
101 changes: 101 additions & 0 deletions coverage/clover.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="UTF-8"?>
<coverage generated="1748985905029" clover="3.2.0">
<project timestamp="1748985905029" name="All files">
<metrics statements="89" coveredstatements="76" conditionals="60" coveredconditionals="51" methods="10" coveredmethods="8" elements="159" coveredelements="135" complexity="0" loc="89" ncloc="89" packages="1" files="2" classes="2"/>
<file name="exam.controller.js" path="/workspaces/skillnet-exam-server/src/controllers/exam.controller.js">
<metrics statements="58" coveredstatements="47" conditionals="48" coveredconditionals="41" methods="6" coveredmethods="4"/>
<line num="9" count="1" type="stmt"/>
<line num="10" count="3" type="stmt"/>
<line num="12" count="3" type="stmt"/>
<line num="13" count="3" type="cond" truecount="2" falsecount="0"/>
<line num="14" count="1" type="stmt"/>
<line num="17" count="3" type="stmt"/>
<line num="27" count="3" type="stmt"/>
<line num="33" count="1" type="stmt"/>
<line num="34" count="0" type="stmt"/>
<line num="48" count="0" type="cond" truecount="0" falsecount="2"/>
<line num="49" count="0" type="stmt"/>
<line num="50" count="0" type="stmt"/>
<line num="53" count="0" type="stmt"/>
<line num="59" count="1" type="stmt"/>
<line num="60" count="0" type="stmt"/>
<line num="62" count="0" type="stmt"/>
<line num="72" count="0" type="stmt"/>
<line num="78" count="1" type="stmt"/>
<line num="79" count="6" type="stmt"/>
<line num="80" count="6" type="stmt"/>
<line num="81" count="6" type="cond" truecount="2" falsecount="0"/>
<line num="82" count="1" type="stmt"/>
<line num="86" count="5" type="stmt"/>
<line num="87" count="5" type="stmt"/>
<line num="89" count="1" type="stmt"/>
<line num="92" count="4" type="stmt"/>
<line num="93" count="4" type="cond" truecount="5" falsecount="0"/>
<line num="94" count="2" type="stmt"/>
<line num="95" count="2" type="stmt"/>
<line num="99" count="1" type="cond" truecount="4" falsecount="1"/>
<line num="100" count="1" type="stmt"/>
<line num="101" count="2" type="stmt"/>
<line num="110" count="1" type="cond" truecount="3" falsecount="1"/>
<line num="111" count="1" type="stmt"/>
<line num="113" count="1" type="stmt"/>
<line num="116" count="3" type="stmt"/>
<line num="120" count="3" type="stmt"/>
<line num="122" count="0" type="stmt"/>
<line num="129" count="1" type="stmt"/>
<line num="130" count="3" type="stmt"/>
<line num="132" count="3" type="cond" truecount="1" falsecount="1"/>
<line num="133" count="0" type="stmt"/>
<line num="134" count="0" type="stmt"/>
<line num="150" count="3" type="stmt"/>
<line num="153" count="3" type="stmt"/>
<line num="169" count="3" type="stmt"/>
<line num="178" count="3" type="stmt"/>
<line num="184" count="1" type="stmt"/>
<line num="185" count="2" type="stmt"/>
<line num="187" count="2" type="cond" truecount="2" falsecount="0"/>
<line num="188" count="1" type="stmt"/>
<line num="189" count="1" type="stmt"/>
<line num="193" count="1" type="stmt"/>
<line num="195" count="1" type="stmt"/>
<line num="196" count="1" type="stmt"/>
<line num="199" count="1" type="stmt"/>
<line num="202" count="1" type="stmt"/>
<line num="204" count="1" type="stmt"/>
</file>
<file name="user.controller.js" path="/workspaces/skillnet-exam-server/src/controllers/user.controller.js">
<metrics statements="31" coveredstatements="29" conditionals="12" coveredconditionals="10" methods="4" coveredmethods="4"/>
<line num="6" count="1" type="stmt"/>
<line num="7" count="2" type="stmt"/>
<line num="11" count="2" type="cond" truecount="2" falsecount="0"/>
<line num="12" count="1" type="stmt"/>
<line num="13" count="1" type="stmt"/>
<line num="16" count="1" type="stmt"/>
<line num="21" count="1" type="stmt"/>
<line num="22" count="4" type="stmt"/>
<line num="23" count="4" type="cond" truecount="2" falsecount="0"/>
<line num="24" count="1" type="stmt"/>
<line num="25" count="1" type="stmt"/>
<line num="27" count="3" type="stmt"/>
<line num="29" count="3" type="cond" truecount="1" falsecount="1"/>
<line num="30" count="0" type="stmt"/>
<line num="31" count="0" type="stmt"/>
<line num="34" count="3" type="stmt"/>
<line num="37" count="3" type="cond" truecount="1" falsecount="1"/>
<line num="38" count="3" type="cond" truecount="2" falsecount="0"/>
<line num="40" count="3" type="stmt"/>
<line num="42" count="2" type="stmt"/>
<line num="50" count="1" type="stmt"/>
<line num="51" count="1" type="stmt"/>
<line num="57" count="1" type="stmt"/>
<line num="58" count="2" type="stmt"/>
<line num="63" count="2" type="cond" truecount="2" falsecount="0"/>
<line num="64" count="1" type="stmt"/>
<line num="65" count="1" type="stmt"/>
<line num="68" count="1" type="stmt"/>
<line num="73" count="1" type="stmt"/>
<line num="74" count="1" type="stmt"/>
<line num="78" count="1" type="stmt"/>
</file>
</project>
</coverage>
3 changes: 3 additions & 0 deletions coverage/coverage-final.json
View file
Open in desktop

Large diffs are not rendered by default.

Loading
Loading