Gathering detailed insights and metrics for contentful-to-sanity
Gathering detailed insights and metrics for contentful-to-sanity
Installations
npm install contentful-to-sanityDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Min. Node Version
>=18.17
Node Version
20.13.1
NPM Version
10.5.1
Releases
18
Languages
2
TypeScript
JavaScript
TypeScript (99.37%)
JavaScript (0.63%)
Developer
sanity-io
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
35 Stars
318 Commits
8 Forks
4 Watchers
18 Branches
38 Contributors
Updated on Nov 18, 2024
Maintainers
53
Package Meta Information
Latest Version
4.2.10
Package Id
contentful-to-sanity@4.2.10
Unpacked Size
1.12 MB
Size
251.65 kB
File Count
14
NPM Version
10.5.1
Node Version
20.13.1
Published on
May 30, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
27
@portabletext/contentful-rich-text-to-portable-text@sanity/block-tools@sanity/client@sanity/schema@stdlib/assert-is-absolute-path@stdlib/assert-is-relative-pathcasecommandercontentful-exportcontentful-managementjavascript-stringifyjsdomjust-compactjust-omitjust-safe-getjust-safe-setmarkdown-itmkdirpnode-fetchobject-hashprettiersharpsvgotiny-invariantvalid-filenamezodzod-validation-error
Dev Dependencies
27
@faker-js/faker@sanity/browserslist-config@sanity/pkg-utils@sanity/semantic-release-preset@sanity/types@types/fs-extra@types/jsdom@types/markdown-it@types/node@types/node-fetch@types/object-hash@typescript-eslint/eslint-plugin@typescript-eslint/parser@vitest/coverage-v8cross-enveslinteslint-config-prettiereslint-plugin-prettiereslint-plugin-simple-import-sortls-enginesmomentprettier-plugin-packagejsonrimrafsanitytypescriptvitestvitest-github-actions-reporter
contentful-to-sanity
This package liberates Contentful spaces, creating Sanity projects and schemas as it goes.
Install
1npm i -g contentful-to-sanity
Or use it on demand with npx:
1npx contentful-to-sanity@latest --help
Usage
1. Open Contentful and navigate to your space: https://app.contentful.com/
- Find your contentful space ID of your project (under Space settings → General)
- Create an API Key and get the Content Delivery API - access token (under Settings → API keys → Content delivery / preview tokens → add api key)
- Create a content management token (under Settings → API keys → Content management tokens → Generate personal token)
2. Setup a clean Sanity v3 Studio and connect it to, or create, the Sanity project and dataset you want as your destination:
1npm create sanity@latest --template clean --create-project "Your Project Name" --dataset production --output-path ./migrate
3. Run the migration, which prepares a dataset.ndjson file for the later import step:
1npx contentful-to-sanity@latest -s <space-id> -t <management-token> -a <access-token> ./migrate
4. Start the dataset import process, which will finish in the background:
1cd ./migrate && npx sanity dataset import ./dataset.ndjson
5. Open ./migrate/sanity.config.ts
If you chose the clean template it should look like this
1import {defineConfig} from 'sanity' 2import {deskTool} from 'sanity/desk' 3import {visionTool} from '@sanity/vision' 4import {schemaTypes} from './schemas' 5 6export default defineConfig({ 7 name: 'default', 8 title: '<project-name>', 9 10 projectId: '<project-id>', 11 dataset: '<dataset>', 12 13 plugins: [deskTool(), visionTool()], 14 15 schema: { 16 types: schemaTypes, 17 }, 18})
Now replace the schemaTypes import with the generated one:
1import {defineConfig} from 'sanity' 2import {deskTool} from 'sanity/desk' 3import {visionTool} from '@sanity/vision' 4-import {schemaTypes} from './schemas' 5+import {types as schemaTypes} from './schema' 6 7export default defineConfig({ 8 name: 'default', 9 title: '<project-name>',
6. Try the Studio 🎉
1npm dev
You don't have to wait for the npx sanity dataset import ./migrate/dataset.ndjson job to finish before the Studio is ready for use. The Studio will keep up to speed with the progress of the import job in real-time.
Commands
For more information on the available commands and their options, run contentful-to-sanity --help.
License
MIT © Sanity.io
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
GitHub workflow tokens follow principle of least privilege
Details
- Info: topLevel 'contents' permission set to 'read': .github/workflows/main.yml:34
- Info: topLevel 'contents' permission set to 'read': .github/workflows/prettier.yml:14
- Info: no jobLevel write permissions found
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/sanity-io/.github/SECURITY.md:1
- Info: Found linked content: github.com/sanity-io/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/sanity-io/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/sanity-io/.github/SECURITY.md:1
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/main.yml:85
Reason
dependency not pinned by hash detected -- score normalized to 5
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:77: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:96: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/prettier.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/prettier.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/prettier.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/prettier.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/sanity-io/contentful-to-sanity/prettier.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:82
- Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 third-party GitHubAction dependencies pinned
- Info: 3 out of 4 npmCommand dependencies pinned
Reason
Found 0/6 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v4.2.10 not signed: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/158134526
- Warn: release artifact v4.2.9 not signed: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/150110747
- Warn: release artifact v4.2.8 not signed: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/150110388
- Warn: release artifact v4.2.7 not signed: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/124410359
- Warn: release artifact v4.2.6 not signed: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/118073622
- Warn: release artifact v4.2.10 does not have provenance: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/158134526
- Warn: release artifact v4.2.9 does not have provenance: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/150110747
- Warn: release artifact v4.2.8 does not have provenance: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/150110388
- Warn: release artifact v4.2.7 does not have provenance: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/124410359
- Warn: release artifact v4.2.6 does not have provenance: https://api.github.com/repos/sanity-io/contentful-to-sanity/releases/118073622
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 24 are checked with a SAST tool
Reason
32 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-x4c5-c7rf-jjgv
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
- Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-8g77-54rh-46hx
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-x565-32qp-m3vf
- Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
- Warn: Project is vulnerable to: GHSA-c76h-2ccp-4975
- Warn: Project is vulnerable to: GHSA-cxrh-j4jr-qwg3
- Warn: Project is vulnerable to: GHSA-64vr-g452-qvp3
- Warn: Project is vulnerable to: GHSA-9cwx-2883-4wfx
- Warn: Project is vulnerable to: GHSA-vg6x-rcgg-rjx6
- Warn: Project is vulnerable to: GHSA-x574-m823-4x7w
- Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8
- Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x
- Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4
- Warn: Project is vulnerable to: GHSA-859w-5945-r5v3
- Warn: Project is vulnerable to: GHSA-9crc-q9x8-hgqq
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
4.7
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More