feat: file framework

X-lab2017 · Aug 19, 2020 · e2ebfc1 · e2ebfc1
1 parent 3ae5c24
commit e2ebfc1
Show file tree

Hide file tree

Showing 21 changed files with 85 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+.vscode
+.idea
+.DS_Store
+*.swp
+*.lock
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Contributing Guide
+
+If you want to contribute to this report, you may need to read our [Contributing guide](./docs/CONTRIBUTING.md) first.
diff --git a/README.md b/README.md
@@ -1,2 +1 @@
-# github-analysis-report-2020
-GitHub digital report 2020
+# GitHub Analysis Report 2020
diff --git a/REPORT.md b/REPORT.md
diff --git a/REPORT_TEMPLATE.md b/REPORT_TEMPLATE.md
@@ -0,0 +1,3 @@
+# GitHub Analysis Report 2020
+
+We anaylsis {{slqs['total-record-count'].text}} records of GitHub logs, there are {{sqls['total-repo-count']}} active repositories and {{sqls['total-developer-count']}} active developers on GitHub during year {{year}}.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1 @@
+# Contributing Guide
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -0,0 +1,7 @@
+# GitHub Analysis Report 2020
+
+> An open source collaborate report for GitHub
+
+- Full access to all records on GitHub
+- Global collaborate
+- Case study supported
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -0,0 +1,2 @@
+* [En](/)
+* [中文](/zh-cn/)
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>GitHub Analysis Report 2020</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="GitHub Analysis Report 2020">
+  <meta name="viewport"
+    content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+</head>
+
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'Hypertrons',
+      repo: 'https://github.com/X-lab2017/github-analysis-report-2020',
+      coverpage: ['/', '/zh-cn/'],
+      loadSidebar: true,
+      loadNavbar: true,
+      mergeNavbar: true,
+    }
+  </script>
+  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+</body>
+
+</html>
diff --git a/docs/zh-cn/CONTRIBUTING.md b/docs/zh-cn/CONTRIBUTING.md
@@ -0,0 +1 @@
+# 贡献指南
diff --git a/sqls/total-developer-count/manifest.json b/sqls/total-developer-count/manifest.json
@@ -0,0 +1,4 @@
+{
+  "config": {},
+  "description": "Return the total active developer count of year {{year}}"
+}
diff --git a/sqls/total-developer-count/post-processor.js b/sqls/total-developer-count/post-processor.js
@@ -0,0 +1,6 @@
+export default async function(data) {
+  if (!Number.isInteger(data[0].count)) {
+    throw new Error('Invalid data');
+  }
+  return data[0].count;
+}
diff --git a/sqls/total-developer-count/sql b/sqls/total-developer-count/sql
@@ -0,0 +1 @@
+SELECT COUNTDistinct(actor_id) as count FROM {{table}}
diff --git a/sqls/total-record-count/manifest.json b/sqls/total-record-count/manifest.json
@@ -0,0 +1,4 @@
+{
+  "config": {},
+  "description": "Return the total record count of year {{year}}"
+}
diff --git a/sqls/total-record-count/post-processor.js b/sqls/total-record-count/post-processor.js
@@ -0,0 +1,6 @@
+export default async function(data) {
+  if (!Number.isInteger(data[0].count)) {
+    throw new Error('Invalid data');
+  }
+  return data[0].count;
+}
diff --git a/sqls/total-record-count/sql b/sqls/total-record-count/sql
@@ -0,0 +1 @@
+SELECT COUNT(*) as count FROM {{table}}
diff --git a/sqls/total-repo-count/manifest.json b/sqls/total-repo-count/manifest.json
@@ -0,0 +1,4 @@
+{
+  "config": {},
+  "description": "Return the total active repo count of year {{year}}"
+}
diff --git a/sqls/total-repo-count/post-processor.js b/sqls/total-repo-count/post-processor.js
@@ -0,0 +1,6 @@
+export default async function(data) {
+  if (!Number.isInteger(data[0].count)) {
+    throw new Error('Invalid data');
+  }
+  return data[0].count;
+}
diff --git a/sqls/total-repo-count/sql b/sqls/total-repo-count/sql
@@ -0,0 +1 @@
+SELECT COUNTDistinct(repo_id) as count FROM {{table}}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Contributing Guide

		If you want to contribute to this report, you may need to read our [Contributing guide](./docs/CONTRIBUTING.md) first.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# GitHub Analysis Report 2020

		We anaylsis {{slqs['total-record-count'].text}} records of GitHub logs, there are {{sqls['total-repo-count']}} active repositories and {{sqls['total-developer-count']}} active developers on GitHub during year {{year}}.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		SELECT COUNTDistinct(actor_id) as count FROM {{table}}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		SELECT COUNTDistinct(repo_id) as count FROM {{table}}