Skip to content

Commit 9659ec4

Browse files
authored
Remove electron references (#184)
* docs: update README to remove electron references, use bin cli name * refactor: update package.json with name, version, main script, and bin Referenced https://medium.com/jspoint/creating-cli-executable-global-npm-module-5ef734febe32 * docs: remove reference to beta * docs: tweak template language * docs: update links for monorepo
1 parent 8d72559 commit 9659ec4

File tree

4 files changed

+20
-40
lines changed

4 files changed

+20
-40
lines changed

.github/ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Summary
2-
What are you thinking?
2+
What's on your mind?
33

44
---
55
### Steps to reproduce

.github/PULL_REQUEST_TEMPLATE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Fixes #[INSERT GITHUB ISSUE NUMBER HERE]
22

33
## Summary**
44

5-
Tell us what you are thinking.
5+
Tell us what you are thinking and how we can best review whether your change is working.
66

77
### Proposed changes**
88

9-
Provide a few more details like what files were modified, added or removed.
9+
Optionally, provide a few more details like what files were modified, added or removed.
1010

1111
* What was modified:
1212
* What was added:

README.md

+9-36
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
![](http://i.imgur.com/n38R14S.png)
44

5-
## A proofreader for your data. Currently in beta.
6-
5+
## A proofreader for your data.
76
Every day, more and more data is created. Journalists, analysts, and data visualizers turn that data into stories and insights.
87

98
But before you can make use of any data, you need to know if it’s reliable. Is it weird? Is it clean? Can I use it to write or make a viz?
@@ -56,11 +55,11 @@ dataproofer --help
5655
```
5756
Run a test
5857
```
59-
node index.js data.csv
58+
dataproofer data.csv
6059
```
6160
Save the results
6261
```
63-
node index.js --json data.csv --out data.json
62+
dataproofer --json data.csv --out data.json
6463
```
6564
Learn how to run specific test suites or tests and output longer or shorter summaries, use the `--help` flag.
6665

@@ -93,13 +92,13 @@ Found a bug? [Let us know](https://github.com/dataproofer/Dataproofer/issues/new
9392
![](http://i.imgur.com/3YekdjW.png)
9493

9594
## Test Suites
96-
### [Information & Diagnostics](https://github.com/dataproofer/info-suite)
95+
### [Information & Diagnostics](https://github.com/dataproofer/Dataproofer/tree/dev/packages/info-suite)
9796
A set of tests that infer descriptive information based on the contents of a table's cells.
9897

9998
+ Check for numeric values in columns
10099
+ Check for strings in columns
101100

102-
### [Core Suite](https://github.com/dataproofer/core-suite)
101+
### [Core Suite](https://github.com/dataproofer/Dataproofer/tree/dev/packages/core-suite)
103102
A set of tests related to common problems and data checks — namely, making sure data has not been truncated by looking for specific cut-off indicators.
104103

105104
+ Check for duplicate rows
@@ -112,13 +111,13 @@ A set of tests related to common problems and data checks — namely, making su
112111
data was exported from a database
113112
+ Check for strings that are exactly 255 characters — an indication there may be missing data lost when the data was exported from MySQL
114113

115-
### [Geo Suite](https://github.com/dataproofer/geo-suite)
114+
### [Geo Suite](https://github.com/dataproofer/Dataproofer/tree/dev/packages/geo-suite)
116115
A set of tests related to common geographic data problems.
117116

118117
+ Check for invalid latitude and longitude values (values outside the range of -180º to 180º)
119118
+ Check for void latitude and longitude values (values at 0º,0º)
120119

121-
### [Stats Suite](https://github.com/dataproofer/stats-suite)
120+
### [Stats Suite](https://github.com/dataproofer/Dataproofer/tree/dev/packages/stats-suite)
122121
A set of test related to common statistical used to detect outlying data.
123122

124123
+ Check for outliers within a column relative to the column's median
@@ -128,24 +127,12 @@ A set of test related to common statistical used to detect outlying data.
128127

129128
## Development
130129

131-
This repo contains two pieces of code, the core library that runs tests and the electron app which houses the UI. You can get them ready like so:
132130
```
133131
git clone https://github.com/dataproofer/Dataproofer.git
134132
cd Dataproofer
135-
cd src
136-
npm install
137-
cd ../electron
138-
npm install
139-
```
140-
141-
You can run the development version of the app from the `electron` folder:
142-
```
143-
cd Dataproofer/electron
144-
npm run electron
133+
yarn
145134
```
146135

147-
If you update the core library (`index.js` or `src/*`) you will need to `npm install` inside `Dataproofer/electron` for it to be updated, as we are relying on the "file:" dependency which copies the source instead of downloading it.
148-
149136
### How You Can Help
150137

151138
#### Write a test
@@ -163,20 +150,6 @@ See our [medium-sized issues](https://github.com/dataproofer/Dataproofer/issues?
163150
#### Plenty of time?
164151
See our [larger issues](https://github.com/dataproofer/Dataproofer/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3Alarge) and leave a comment
165152

166-
### Modifying a test suite
167-
All tests belong to a suite, which is essentially just a node module that packages a group of tests together. In order to modify a test or add a new test to a suite, you will want to clone the project and link it. Let's say we want to modify the [core-suite](https://github.com/dataproofer/core-suite).
168-
```
169-
git clone https://github.com/dataproofer/core-suite.git
170-
cd core-suite
171-
npm install
172-
npm link
173-
174-
cd ../Dataproofer
175-
cd electron
176-
npm link dataproofer-core-suite
177-
```
178-
Now when you change anything inside `core-suite` (like editing a test or making a new one) you can see your changes reflected when you run the app. Follow the instructions below for creating a new test in your suite!
179-
180153
![](http://i.imgur.com/3YekdjW.png)
181154

182155
### Creating a new test
@@ -186,7 +159,7 @@ Now when you change anything inside `core-suite` (like editing a test or making
186159
+ `require` that test in a suite's [index.js](https://github.com/dataproofer/suite-template/blob/master/index.js)
187160
+ Add that test to the `exports` in [index.js](https://github.com/dataproofer/suite-template/blob/master/index.js)
188161

189-
Tests are made up of a few parts. Here's a brief over-view. For a more in-depth look, dive into the [documentation](https://github.com/dataproofer/dataproofertest-js/blob/master/DOCUMENTATION.md#util).
162+
Tests are made up of a few parts. Here's a brief over-view. For a more in-depth look, dive into the [documentation](https://github.com/dataproofer/Dataproofer/tree/dev/packages/dataproofertest-js).
190163

191164
#### .name()
192165
This is the name of your test. It shows up in the test-selection screen as well as on the results page

package.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
{
2+
"name": "dataproofer",
3+
"version": "2.0.0",
4+
"description": "A proofreader for your data",
5+
26
"private": true,
37
"workspaces": [
48
"src",
59
"packages/*"
610
],
11+
"main": "./src/index.js",
12+
"bin": {
13+
"dataproofer": "./src/index.js"
14+
},
715
"scripts": {
8-
"dataproofer": "yarn node src/index.js",
916
"lint": "yarn eslint . --ext .js"
1017
},
1118
"devDependencies": {

0 commit comments

Comments
 (0)