Auto commit experiment

PR-URL: #136

Author: tshemsedinov

.editorconfig

@@ -0,0 +1,38 @@
+# Software engineering self assessment
+
+$BADGE
+
+## Skills
+
+- [Programming fundamentals](Skills/Programming.md)
+- [JavaScript](Skills/JavaScript.md)
+- [Asynchronous programming](Skills/Async.md)
+- [Node.js and Backend](Skills/NodeJS.md)
+- [Multi-paradigm programming](Skills/Paradigms.md)
+
+## How to use
+
+- Fork repository
+- Create branch, for example: `2023-autumn` or `2024-winter`
+- In new branch add following levels or leave line untouched in each file as of :
+  - 👂 heard, 🎓 known, 🖐️ used, 🙋 explained, 📢 talked, 🔬 researched, 🚀 constructed
+- Now you can create pull request and merge this to main branch of your fork (prefer single commit: use squash and merge)
+- Repeat self assessment after course or training
+- Now You can compare branches with URL:
+  - `https://github.com/<YOUR-ACCOUNT>/SelfAssessment/compare/2023-autumn...2024-winter`
+
+## Example
+
+It should look like following example after filling it out:
+
+```
+- Syntax and concepts
+  - value: 🙋 explained
+  - identifier: 🖐️ used
+  - variable: 🙋 explained
+  - constant: 🖐️ used
+  - scalar: 🖐️ used
+  - literal: 👂 heard
+  - expression: 🖐️ used
+  - heap: 🎓 known
+```

.eslintignore .github/src/.eslintignore

@@ -4,34 +4,17 @@
   "author": "Timur Shemsedinov <[email protected]>",
   "license": "MIT",
   "description": "Software engineering self assessment",
-  "keywords": [
-    "node.js",
-    "javascript",
-    "software",
-    "programming",
-    "software engineering",
-    "self assessment"
-  ],
   "readmeFilename": "README.md",
   "engines": {
     "node": ">=18.0.0"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/HowProgrammingWorks/SelfAssessment.git"
-  },
-  "bugs": {
-    "url": "https://github.com/HowProgrammingWorks/SelfAssessment/issues",
-    "email": "[email protected]"
-  },
-  "homepage": "https://github.com/HowProgrammingWorks/Index",
   "scripts": {
-    "test": "node ./src/skills.js",
     "lint": "eslint . && prettier -c \"**/*.js\" \"**/*.json\"",
     "fmt": "prettier --write \"**/*.js\" \"**/*.json\""
   },
   "dependencies": {
-    "concolor": "^1.1.0"
+    "concolor": "^1.1.0",
+    "metautil": "^5.2.0"
   },
   "devDependencies": {
     "eslint": "^8.56.0",

.eslintrc.json .github/src/.eslintrc.json

@@ -0,0 +1,70 @@
+'use strict';
+
+const fs = require('node:fs').promises;
+const path = require('node:path');
+const cp = require('node:child_process');
+const metautil = require('metautil');
+const concolor = require('concolor');
+
+const TITLE = 'Software engineering self assessment';
+const PARSING_TIMEOUT = 1000;
+const EXECUTION_TIMEOUT = 5000;
+
+const PATH = path.join(process.cwd(), '../..');
+
+const OUT = cp.execSync('git config --get remote.origin.url').toString();
+const REPO = metautil.between(OUT, ':', '.');
+const LINK = 'https://github.com/' + REPO;
+
+const BASE = 'https://img.shields.io/badge/Self_Assessment-skills-009933';
+const STYLE = `style=flat-square`;
+const BADGE = `[![Skills](${BASE}?${STYLE})](${LINK})`;
+
+const codeBlock = (code) => '```\n' + code + '\n```';
+
+const loadFile = async (file) => {
+  const fileName = path.join(PATH, file);
+  const data = await fs.readFile(fileName, 'utf8');
+  return data;
+};
+
+const countLines = (s) => {
+  let count = 1;
+  for (let i = 0; i < s.length; i++) {
+    if (s[i] === '\n') count++;
+  }
+  return count;
+};
+
+const analise = async (section) => {
+  const md = await loadFile(`Skills/${section}.md`);
+  const lines = countLines(md);
+  console.log(concolor.info(`Lines: ${lines}`));
+  return ;
+};
+
+(async () => {
+  console.log(concolor.white(TITLE));
+  console.log(concolor.info('Auto Checker'));
+
+  const files = await fs.readdir(`${PATH}/Skills/`);
+  const sections = files
+    .filter((file) => file.endsWith('.md'))
+    .map((file) => file.substring(0, file.length - '.md'.length));
+  for (const section of sections) {
+    console.log(concolor`\nCheck: ${section}(b,white)`);
+    await analise(section);
+  }
+
+  const badgeCode = codeBlock(BADGE);
+
+  const report = `## ${TITLE}\n\n${BADGE}\n\n${badgeCode}\n`;
+  await fs.writeFile(`${PATH}/Profile/REPORT.md`, report);
+
+  const readme = await loadFile('.github/src/Templates/README.md');
+  const newReadme = readme.replace('$BADGE', BADGE);
+  await fs.writeFile(`${PATH}/README.md`, newReadme);
+
+  console.log('');
+  process.exit(0);
+})();

.prettierignore .github/src/.prettierignore

@@ -1,10 +1,12 @@
-name: Check slills
+name: Check skills
 on: pull_request
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
       - name: Node.js
         uses: actions/setup-node@v4
         with:
@@ -16,4 +18,13 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-
       - run: npm ci
-      - run: npm t
+        working-directory: .github/src
+      - run: node skills.js
+        working-directory: .github/src
+      - name: Generate results
+        run: |
+          git config --global user.name "Metarhia skill bot"
+          git config --global user.email "[email protected]"
+          git add ./Profile ./README.md
+          git commit -m "Automated skill analysis"
+          git push

.prettierrc .github/src/.prettierrc

@@ -0,0 +1 @@
+## Software engineering self assessment