Skip to content

Commit d4f546f

Browse files
authored
Merge pull request #20 from Eyas/format
Setup CI
2 parents e286dd9 + 32a0f81 commit d4f546f

20 files changed

Lines changed: 7337 additions & 182 deletions

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
node_modules/
2+
coverage/
23
dist/
4+
tsconfig.tsbuildinfo

.npmignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
**/*
2+
!dist/src/**/*

.travis.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
language: node_js
2+
node_js:
3+
- "node"
4+
git:
5+
depth: 1
6+
after_success: npm run coverage_on_travis

.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"editor.defaultFormatter": "esbenp.prettier-vscode",
3+
"editor.formatOnSave": true,
4+
"typescript.tsdk": "node_modules/typescript/lib"
5+
}

README.md

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,26 @@ npm install react-schemaorg
2727

2828
To insert a simple JSON-LD snippet:
2929

30-
```ts
30+
```tsx
3131
import { Person } from "schema-dts";
3232
import { JsonLd } from "react-schemaorg";
3333

3434
export function GraceHopper() {
35-
return <JsonLd<Person>
36-
item={{
37-
"@context": "https://schema.org",
38-
"@type": "Person",
39-
name: "Grace Hopper",
40-
alternateName: "Grace Brewster Murray Hopper",
41-
alumniOf: {
42-
"@type": "CollegeOrUniversity",
43-
name: ["Yale University", "Vassar College"]
44-
},
45-
knowsAbout: ["Compilers", "Computer Science"]
46-
}}/>;
35+
return (
36+
<JsonLd<Person>
37+
item={{
38+
"@context": "https://schema.org",
39+
"@type": "Person",
40+
name: "Grace Hopper",
41+
alternateName: "Grace Brewster Murray Hopper",
42+
alumniOf: {
43+
"@type": "CollegeOrUniversity",
44+
name: ["Yale University", "Vassar College"],
45+
},
46+
knowsAbout: ["Compilers", "Computer Science"],
47+
}}
48+
/>
49+
);
4750
}
4851
```
4952

@@ -52,25 +55,27 @@ export function GraceHopper() {
5255
To set JSON-LD in React Helmet, you need to pass it to the `script={[...]}` prop
5356
array in the `Helmet` component:
5457

55-
```tsx
58+
```tsx
5659
import { Person } from "schema-dts";
5760
import { helmetJsonLdProp } from "react-schemaorg";
5861
import { Helmet } from "react-helmet";
5962

60-
<Helmet script={[
61-
helmetJsonLdProp<Person>({
62-
"@context": "https://schema.org",
63-
"@type": "Person",
64-
name: "Grace Hopper",
65-
alternateName: "Grace Brewster Murray Hopper",
66-
alumniOf: {
67-
"@type": "CollegeOrUniversity",
68-
name: ["Yale University", "Vassar College"]
69-
},
70-
knowsAbout: ["Compilers", "Computer Science"]
71-
}),
72-
]} />
73-
```
63+
<Helmet
64+
script={[
65+
helmetJsonLdProp<Person>({
66+
"@context": "https://schema.org",
67+
"@type": "Person",
68+
name: "Grace Hopper",
69+
alternateName: "Grace Brewster Murray Hopper",
70+
alumniOf: {
71+
"@type": "CollegeOrUniversity",
72+
name: ["Yale University", "Vassar College"],
73+
},
74+
knowsAbout: ["Compilers", "Computer Science"],
75+
}),
76+
]}
77+
/>;
78+
```
7479

7580
## Developers
7681

babel.config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Used for Jest only.
2+
module.exports = {
3+
plugins: ["@babel/plugin-transform-react-jsx"],
4+
presets: [
5+
["@babel/preset-env", { targets: { node: "current" } }],
6+
["@babel/preset-typescript"],
7+
],
8+
};

jest.config.js

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// For a detailed explanation regarding each configuration property, visit:
2+
// https://jestjs.io/docs/en/configuration.html
3+
4+
module.exports = {
5+
// Indicates whether the coverage information should be collected while executing the test
6+
collectCoverage: true,
7+
8+
// The directory where Jest should output its coverage files
9+
coverageDirectory: "coverage",
10+
11+
// An array of regexp pattern strings used to skip coverage collection
12+
// coveragePathIgnorePatterns: [
13+
// "/node_modules/"
14+
// ],
15+
16+
// A list of reporter names that Jest uses when writing coverage reports
17+
// coverageReporters: [
18+
// "json",
19+
// "text",
20+
// "lcov",
21+
// "clover"
22+
// ],
23+
24+
// Make calling deprecated APIs throw helpful error messages
25+
// errorOnDeprecated: false,
26+
27+
// The test environment that will be used for testing
28+
testEnvironment: "node",
29+
30+
// The glob patterns Jest uses to detect test files
31+
testMatch: ["**/test/**/*_test.[jt]s?(x)"],
32+
testPathIgnorePatterns: ["/node_modules/", "/dist/"],
33+
};

0 commit comments

Comments
 (0)