Skip to content

Commit

Permalink
Javascript code snippets (#108)
Browse files Browse the repository at this point in the history
* very work in progress for initial javascript setup

* working setup to test javascript code locally

* basic static web server conf

* more javascript code snippets

* all 2d javascript snippets compiling and running

* add ci for javascript 2d

* add javascript 3d code snippets

* fix both javascript package.json

* removed advanced colisions from javascript 3d

* javascript injection

* fix 3d index.ts

* multiple fixes related to diff with master review

* more self review on diff file
  • Loading branch information
Vrixyz authored Jun 23, 2024
1 parent f36c8aa commit 527327f
Show file tree
Hide file tree
Showing 80 changed files with 12,738 additions and 876 deletions.
24 changes: 19 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,31 @@ env:
CARGO_TERM_COLOR: always

jobs:
check-code-snippets:
check-injection:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run injection script locally
run: find docs/user_guides/templates/ -type f -print0 | OUTPUT_FOLDER=docs/user_guides/templates_injected xargs -0 ./inject_code_in_user_guides.sh
test-code-snippets-rust:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Linux dependencies
uses: ./.github/actions/install-linux-deps
- name: Code snippets compilation check + tests
- name: Tests injection + code snippets
run: cd docs-examples && cargo test
check-injection:
check-code-snippets-javascript:
runs-on: ubuntu-latest
strategy:
matrix:
dimension: [2d, 3d]
defaults:
run:
working-directory: ./docs-examples/${{ matrix.dimension }}/javascript
steps:
- uses: actions/checkout@v4
- name: Check injection script
run: find docs/user_guides/templates/ -type f -print0 | OUTPUT_FOLDER=docs/user_guides/templates_injected xargs -0 ./inject_code_in_user_guides.sh
- name: Install dependencies
run: npm i
- name: Builds javascript snippets.
run: npm run build
8 changes: 4 additions & 4 deletions docs-examples/2d/bevy/examples/colliders2.rs
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,12 @@ fn setup_physics(mut commands: Commands) {
));
// DOCUSAURUS: Groups1 stop

// DOCUSAURUS: ActiveCollisions1 start
// DOCUSAURUS: ActiveCollisionTypes1 start
/* Set the active collision types when the collider is created. */
commands
.spawn(Collider::ball(0.5))
.insert(ActiveCollisionTypes::default() | ActiveCollisionTypes::KINEMATIC_STATIC);
// DOCUSAURUS: ActiveCollisions1 stop
// DOCUSAURUS: ActiveCollisionTypes1 stop

// DOCUSAURUS: ActiveEvents1 start
/* Set the active events when the collider is created. */
Expand Down Expand Up @@ -216,14 +216,14 @@ fn modify_collider_groups(
}
// DOCUSAURUS: Groups2 stop

// DOCUSAURUS: ActiveCollisions2 start
// DOCUSAURUS: ActiveCollisionTypes2 start
/* Set the active collision types inside of a system. */
fn modify_collider_active_collision_types(mut active_types: Query<&mut ActiveCollisionTypes>) {
for mut active_types in active_types.iter_mut() {
*active_types = (ActiveCollisionTypes::default() | ActiveCollisionTypes::KINEMATIC_STATIC);
}
}
// DOCUSAURUS: ActiveCollisions2 stop
// DOCUSAURUS: ActiveCollisionTypes2 stop

// DOCUSAURUS: ActiveEvents2 start
/* Set the active events inside of a system. */
Expand Down
130 changes: 130 additions & 0 deletions docs-examples/2d/javascript/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
3 changes: 3 additions & 0 deletions docs-examples/2d/javascript/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#!/bin/sh

rm -rf public/dist && mkdir -p public/dist && webpack --mode=development
Loading

0 comments on commit 527327f

Please sign in to comment.