Skip to content

Commit

Permalink
feat: init
Browse files Browse the repository at this point in the history
  • Loading branch information
nhevia committed Aug 27, 2020
0 parents commit dcddbb5
Show file tree
Hide file tree
Showing 4 changed files with 268 additions and 0 deletions.
116 changes: 116 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
85 changes: 85 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 24 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"name": "@simple-docs/simple-docs",
"version": "0.1.0",
"description": "\"Simple documentation tool\"",
"main": "sdocs.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/nhevia/simple-docs.git"
},
"keywords": [
"docs",
"documentation",
"simple"
],
"author": "Nicolas Hevia",
"license": "MIT",
"bugs": {
"url": "https://github.com/nhevia/simple-docs/issues"
},
"homepage": "https://github.com/nhevia/simple-docs#readme"
}
43 changes: 43 additions & 0 deletions sdocs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
const fsp = require('fs').promises;
const fs = require('fs');
const glob = require("glob");

const filepath = './docs.md'

const options = {
ignore: '**/node_modules/**'
}

const files = glob.sync("**/**.+(js|jsx|ts|tsx)", options)

const readFile = file => {
return new Promise((resolve) => {
fs.readFile(file, {encoding: 'utf-8'}, function (err, data) {
if (err) throw err;

const start = data.indexOf('/*sdoc')
if (start > -1 && start < 10 ) {
const ends = data.indexOf('*/')
resolve({filename: file, data: data.slice(start + 7, ends).trim()})
} else {
resolve('')
}
});
})
}

const readFiles = async () => {
return Promise.all(files.map(item => readFile(item)))
}

const parseData = async () => {
const read = await readFiles()
const filtered = read.filter(el => el !== '')
const textToWrite = filtered.map(el => `>${el.filename}\n\n ${el.data}`)
return textToWrite.join('\n')
}


(async () => {
await fsp.writeFile(filepath, await parseData(), 'utf8');
})();

0 comments on commit dcddbb5

Please sign in to comment.