Installations
npm install babel-preset-kyt-react
Releases
kyt-starter-universal-src@2.0.6
Published on 03 Jun 2024
kyt-starter-server-src@1.2.10
Published on 03 Jun 2024
kyt@1.2.9
Published on 03 Jun 2024
kyt-starter-static-src@2.0.6
Published on 03 Jun 2024
kyt-runtime@1.2.49
Published on 30 May 2024
kyt-starter-universal@2.0.2
Published on 30 May 2024
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
15.1.0
NPM Version
lerna/4.0.0/node@v15.1.0+x64 (darwin)
Statistics
1,921 Stars
859 Commits
110 Forks
31 Watching
30 Branches
69 Contributors
Updated on 08 Nov 2024
Languages
JavaScript (99.38%)
EJS (0.37%)
SCSS (0.22%)
Shell (0.03%)
Total Downloads
Cumulative downloads
Total Downloads
932,861
Last day
-38.1%
1,576
Compared to previous day
Last week
-3.1%
8,640
Compared to previous week
Last month
-30.4%
25,932
Compared to previous month
Last year
194.5%
351,792
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
kyt
Deprecation notice
This project is still used internally at the new york times but has long been deprecated. Please don't expect any support or documented releases going forward.
Every sizable JavaScript web app needs a common foundation: a setup to build, run, test and lint your code. kyt
is a toolkit that encapsulates and manages the configuration for web apps.
Read more about kyt in our blog post.
Quick Start
- Install Node.js (v14.0+ required). On Mac, this is as simple as:
1brew install nvm 2nvm use
yarn add kyt
yarn kyt setup
- This will set up your project with application and configuration files so that you can get started withkyt
. Learn more about setup.yarn dev
- Check out
http://localhost:3000
Features
- Isomorphic rendering of JavaScript apps
- Client and server hot-reloading in dev
- Babel presets for general ES6 support and React
- ESLint configuration and custom rules
- Jest presets for running unit tests and CSS-in-JS linting
- Optional client-only and server-only modes
- Ability to override Webpack configuration from
kyt.config.js
How it Works
kyt
manages configuration for all aspects of development. It can be installed as a dependency into a new or existing project. kyt
’s goal is to encapsulate only development tools, giving users the freedom to control their source directory and make important decisions about app architecture. kyt
provides a command line interface for running all development tools.
Developers design their own architecture, choosing the tools they need for rendering, styling, and handling data.
For advanced use cases, kyt
enables developers to add additional tools and configuration.
See our config override instructions for details, and our recipes for examples.
Setting up a kyt project
kyt setup
is a utility for bootstrapping kyt
projects and installing starter-kyts. It can be run to create a new project or integrate kyt
with an existing project.
See the kyt documentation for more details.
Command line
kyt
includes a command line program with all the commands needed for development.
Running kyt setup
includes these commands as scripts in your package.json
:
yarn dev
Or you can run a command using yarn kyt {command}
:
yarn kyt build
Here are the available commands:
dev
starts a development environmentbuild
compiles server and client code for production usehelp
shows commands and their documentation
See our CLI docs for further details.
Conventions
kyt
follows a few simple conventions.
All projects must have the following structure:
src/
client/
index.js
polyfills.js
server/
index.js
polyfills.js
Each index.js
file acts as the build entry.
(Note that server/index.js
is not required if hasServer
is false
in config).
(Note that client/index.js
is not required if hasClient
is false
in config).
If you're setting up a new project see our full list of conventions.
Configuration
kyt
allows you to specify options in a kyt.config.js
file.
See the kyt config docs for instructions.
kyt
uses Webpack to compile src code.
See our recipes for extending configuration.
kyt
respects Babel config files defined at the root of user projects, and provides presets to provide opinionated configurations. (If no Babel config file is defined in the user project, babel-preset-kyt-core
is used when compiling Webpack.)
starter-kyt
s
While kyt
can be easily integrated into new or existing Node projects, it is even more powerful when used with a starter-kyt
. A starter-kyt
offers the benefits of a boilerplate while minimizing the amount of new tools to learn and maintain.
The kyt setup
command installs any preconfigured starter-kyt
git repository, adding additional dependencies and building a source directory.
How to build a starter-kyt
See additional info on how to build a starter-kyt
.
How to contribute to kyt
Want to help? See details here
Need Help?
Changelog
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 4 commits out of 20 are checked with a SAST tool
Reason
Found 9/21 approved changesets -- score normalized to 4
Reason
4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/continuous-integration.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/nytimes/kyt/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/nytimes/kyt/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/nytimes/kyt/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/nytimes/kyt/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/continuous-integration.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/nytimes/kyt/continuous-integration.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/continuous-integration.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/nytimes/kyt/continuous-integration.yml/main?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
58 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-33f9-j839-rf8h
- Warn: Project is vulnerable to: GHSA-c36v-fmgq-m8hx
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
- Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
- Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
- Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
- Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
- Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
- Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
- Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
- Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
- Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
- Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
- Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-rxrc-rgv4-jpvx
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
- Warn: Project is vulnerable to: GHSA-3f95-r44v-8mrg
- Warn: Project is vulnerable to: GHSA-28xr-mwxg-3qc8
- Warn: Project is vulnerable to: GHSA-9p95-fxvg-qgq2
- Warn: Project is vulnerable to: GHSA-9w5j-4mwv-2wj8
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3.9
/10
Last Scanned on 2024-07-15
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