Skip to content

Commit 06edcf7

Browse files
committed
build: add devcontainer configuration
1 parent f141a9b commit 06edcf7

File tree

3 files changed

+118
-0
lines changed

3 files changed

+118
-0
lines changed

.devcontainer/README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
[![Open in Dev Containers][dev-container-image]][dev-container-url]
22+
23+
# Development Container
24+
25+
> Development container for `stdlib`.
26+
27+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
28+
29+
<section class="intro">
30+
31+
This folder includes configuration for developing the project in a local container or using [GitHub Codespaces][github-codespaces].
32+
33+
</section>
34+
35+
<!-- /.intro -->
36+
37+
<!-- Section to include usage notes. -->
38+
39+
<section class="usage">
40+
41+
</section>
42+
43+
<!-- /.usage -->
44+
45+
<!-- Section to include usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
46+
47+
<section class="notes">
48+
49+
</section>
50+
51+
<!-- /.notes -->
52+
53+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
54+
55+
<section class="links">
56+
57+
[dev-container-image]: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
58+
59+
[dev-container-url]: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/stdlib-js/stdlib/
60+
61+
[github-codespaces]: https://github.com/features/codespaces
62+
63+
</section>
64+
65+
<!-- /.links -->

.devcontainer/devcontainer.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "stdlib - OSS Development",
3+
"image": "mcr.microsoft.com/devcontainers/javascript-node:1-20-bullseye",
4+
"features": {
5+
"ghcr.io/devcontainers/features/python:1": {},
6+
"ghcr.io/rocker-org/devcontainer-features/r-apt:0": {},
7+
"ghcr.io/julialang/devcontainer-features/julia:1": {},
8+
"ghcr.io/marcozac/devcontainer-features/shellcheck:1": {},
9+
"ghcr.io/rocker-org/devcontainer-features/pandoc:1": {}
10+
},
11+
"postCreateCommand": "./.devcontainer/post-create",
12+
"customizations": {
13+
"codespaces": {
14+
"openFiles": [
15+
"README.md"
16+
]
17+
},
18+
"vscode": {
19+
"settings": {
20+
"resmon.show.battery": false,
21+
"resmon.show.cpufreq": false
22+
},
23+
"extensions": [
24+
"dbaeumer.vscode-eslint",
25+
"EditorConfig.EditorConfig",
26+
"formulahendry.code-runner",
27+
"vsls-contrib.codetour"
28+
]
29+
}
30+
}
31+
}

.devcontainer/post-create

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
#!/usr/bin/env bash
2+
#
3+
# @license Apache-2.0
4+
#
5+
# Copyright (c) 2024 The Stdlib Authors.
6+
#
7+
# Licensed under the Apache License, Version 2.0 (the "License");
8+
# you may not use this file except in compliance with the License.
9+
# You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing, software
14+
# distributed under the License is distributed on an "AS IS" BASIS,
15+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
# See the License for the specific language governing permissions and
17+
# limitations under the License.
18+
19+
# Script to set up a development environment.
20+
21+
make install
22+
make init

0 commit comments

Comments
 (0)