https://github.com/eltorio/code-stats
Count line of codes and display stats
https://github.com/eltorio/code-stats
Last synced: 3 months ago
JSON representation
Count line of codes and display stats
- Host: GitHub
- URL: https://github.com/eltorio/code-stats
- Owner: eltorio
- Created: 2022-11-27T11:01:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-27T13:56:25.000Z (over 2 years ago)
- Last Synced: 2024-04-26T10:05:23.622Z (about 1 year ago)
- Language: TypeScript
- Size: 217 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple ES6+ tool for counting lines of code in project
This utility is developped for internal use.
Feel free to use it but there is strictly no support.
## Basic Promise usage
### Single directory
```ts
import { LineCount,GlobalResults } from "@sctg/code-stats";
LineCount.countLines("src").then((results: GlobalResults) => {
console.log(results);
});
```
### Multiple directories
```ts
import { LineCount,GlobalResults } from "@sctg/code-stats";
LineCount.countLines(["dirA","dirB"]).then((results: GlobalResults) => {
console.log(results);
});
```
## Basic Callback usage
### Single directory
```ts
const onComplete = (count:GlobalResults)=>{
console.log(count)
}
LineCount.countLinesCb("src",onComplete);
```
### Multiple directories
```ts
const onComplete = (count:GlobalResults)=>{
console.log(count)
}
LineCount.countLinesCb(["dirA","dirB"],onComplete);
```
## Javascript ES6
While natively wrote in Typescript it is obviously transpiled to Javascript with types definition:
```js
import { LineCount,GlobalResults } from "@sctg/code-stats";
LineCount.countLines(["dirA","dirB"]).then((results) => {
console.log(results);
});
```
## Static stats usage
```ts
import {LineCount} from "@sctg/code-stats"
const results = await LineCount.countLines(['src','functions'])
fs.writeFile(
"./src/config/codeStats.json",
JSON.stringify(results),
"utf8",
function (err) {
if (err) return console.log(err);
}
);
```
### Sample output
```json
{
"undefined": {
"files": 53,
"lines": null,
"codeLines": null
},
"Vue": {
"files": 61,
"lines": 6839,
"codeLines": 6532
},
"Stylesheets": {
"files": 14,
"lines": 189,
"codeLines": 155
},
"Typescript": {
"files": 34,
"lines": 3369,
"codeLines": 2957
},
"Json": {
"files": 26,
"lines": 1532,
"codeLines": 1531
}
}
```
## license
Without any form of… Provide as-is…
Under MIT License.