Skip to content

docs: improve demo and docs #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.

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
merged 3 commits into from
Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ yarn.lock
coverage
dist
.parcel-cache
demo/parse-git-diff.js
demo/yarn.lock
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@

A parser for git diff.

- [Installation](#installation)
- [Demo](#demo)
- [Usage](#usage)
- [Examples](#examples)
- [AST Format](#ast-format)
- [License](#license)

## Installation

```bash
Expand Down Expand Up @@ -463,6 +470,10 @@ index 0e05564..aa39060 100644

</details>

## AST Format

See the [types.ts](https://github.com/yeonjuan/parse-git-diff/blob/main/src/types.ts) file for all AST formats.

## License

[MIT](./LICENSE)
23 changes: 23 additions & 0 deletions demo/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
6 changes: 6 additions & 0 deletions demo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Demo

## Available Scripts

- `yarn start`
- `yarn build`
73 changes: 0 additions & 73 deletions demo/index.html

This file was deleted.

47 changes: 47 additions & 0 deletions demo/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"name": "demo",
"version": "0.1.0",
"private": true,
"dependencies": {
"@testing-library/jest-dom": "^5.14.1",
"@testing-library/react": "^13.0.0",
"@testing-library/user-event": "^13.2.1",
"@types/jest": "^27.0.1",
"@types/node": "^16.7.13",
"@types/react": "^18.0.0",
"@types/react-dom": "^18.0.0",
"codemirror": "^5.65.11",
"react": "^18.2.0",
"react-codemirror2": "^7.2.1",
"react-dom": "^18.2.0",
"react-scripts": "5.0.1",
"typescript": "^4.4.2",
"web-vitals": "^2.1.0",
"parse-git-diff": "file:../"
},
"homepage": "/parse-git-diff",
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
"eject": "react-scripts eject"
},
"eslintConfig": {
"extends": [
"react-app",
"react-app/jest"
]
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
}
}
41 changes: 41 additions & 0 deletions demo/public/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-react-app"
/>
<!--
manifest.json provides metadata used when your web app is installed on a
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.

Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>Demo | parse-git-diff</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.

You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.

To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>
25 changes: 25 additions & 0 deletions demo/public/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"short_name": "React App",
"name": "Create React App Sample",
"icons": [
{
"src": "favicon.ico",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
},
{
"src": "logo192.png",
"type": "image/png",
"sizes": "192x192"
},
{
"src": "logo512.png",
"type": "image/png",
"sizes": "512x512"
}
],
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
}
3 changes: 3 additions & 0 deletions demo/public/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Disallow:
80 changes: 80 additions & 0 deletions demo/src/App.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
.app {
display: flex;
flex-direction: column;
flex: 1;
}

.header {
display: flex;
align-items: center;
background: #1a2b34;
padding: 10px;
font-weight: bold;
}

.nav {
margin-left: auto;
margin-right: 0;
}

.row {
display: flex;
flex-direction: row;
justify-content: space-between;
align-items: stretch;
width: 100%;
}

.row > div {
width: 50%;
padding: 4px;
flex: 1;
display: flex;
flex-direction: column;
}

@media (max-width: 800px) {
.row {
flex-direction: column;
align-items: unset;
}

.row > div {
width: 100%;
}
}

h1 {
font-size: 18px;
color: white;
}

h2 {
color: #1a2b34;
font-size: 16px;
padding: 10px;
}

body {
background: #efefef;
display: flex;
flex-direction: column;
height: 100vh;
margin: 0;
}

main {
flex: 1;
display: flex;
}

#root {
flex: 100%;
display: flex;
}

a,
a:visited {
text-decoration: underline;
color: white;
}
44 changes: 44 additions & 0 deletions demo/src/App.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import React, { useMemo, useState } from 'react';
import DiffEditor from './components/DiffEditor';
import ASTOutput from './components/ASTOutput';
import parseGitDiff from 'parse-git-diff';
import './App.css';

const INITIAL_VALUE = `diff --git a/newfile.md b/newfile.md
new file mode 100644
index 0000000..aa39060
--- /dev/null
+++ b/newfile.md
@@ -0,0 +1 @@
+newfile
`;

function App() {
const [value, setValue] = useState<string>(INITIAL_VALUE);
const ast = useMemo(() => parseGitDiff(value), [value]);

return (
<div className="app">
<header className="header">
<h1>parse-git-diff</h1>
<nav className="nav">
<a href="https://github.com/yeonjuan/parse-git-diff">Github</a>
</nav>
</header>
<main>
<div className="row">
<div>
<h2>Input</h2>
<DiffEditor value={value} onChange={setValue} />
</div>
<div>
<h2>Output</h2>
<ASTOutput ast={ast} />
</div>
</div>
</main>
</div>
);
}

export default App;
12 changes: 12 additions & 0 deletions demo/src/components/ASTOutput.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.ast-output-container {
height: 100%;
overflow-y: auto;
}

.ast-output {
height: 100%;
}

.CodeMirror {
height: 100%;
}
Loading