You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
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.
104
103
105
104
+ Check for duplicate rows
@@ -112,13 +111,13 @@ A set of tests related to common problems and data checks — namely, making su
112
111
data was exported from a database
113
112
+ Check for strings that are exactly 255 characters — an indication there may be missing data lost when the data was exported from MySQL
You can run the development version of the app from the `electron` folder:
142
-
```
143
-
cd Dataproofer/electron
144
-
npm run electron
133
+
yarn
145
134
```
146
135
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
-
149
136
### How You Can Help
150
137
151
138
#### Write a test
@@ -163,20 +150,6 @@ See our [medium-sized issues](https://github.com/dataproofer/Dataproofer/issues?
163
150
#### Plenty of time?
164
151
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
165
152
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).
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
-
180
153

181
154
182
155
### Creating a new test
@@ -186,7 +159,7 @@ Now when you change anything inside `core-suite` (like editing a test or making
186
159
+`require` that test in a suite's [index.js](https://github.com/dataproofer/suite-template/blob/master/index.js)
187
160
+ Add that test to the `exports` in [index.js](https://github.com/dataproofer/suite-template/blob/master/index.js)
188
161
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).
190
163
191
164
#### .name()
192
165
This is the name of your test. It shows up in the test-selection screen as well as on the results page
0 commit comments