Merge pull request #117 from netcreateorg/dev

v1.5.0 January 2024 Data Collection

Author: benloh

build/.editorconfig renamed to .editorconfig

@@ -0,0 +1,5 @@
+# if this doesn't seem to work, try using ignorePatterns in .eslintrc.js
+#  e.g. 
+#  ignorePatterns: ['**/_dist/*'],
+
+ 

.eslintignore

@@ -0,0 +1,67 @@
+/*///////////////////////////////// ABOUT \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\
+
+  These are the specific overrides we use. It's imported in our
+  .eslintrc.js file
+
+\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ * /////////////////////////////////////*/
+
+const LINT_LEVEL = process.env.GS_LINT_LEVEL || 1;
+
+/// RULE OVERRIDES ////////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+const URSYS_STYLE = {
+  /* ursys style overrides */
+  'spaced-comment': 'off',
+  'camelcase': 'off',
+  'comma-dangle': ['error', 'never'],
+  'no-underscore-dangle': 'off',
+  'lines-between-class-members': 'off',
+  'no-bitwise': 'off',
+  'import/prefer-default-export': 'off',
+  'object-shorthand': 'off'
+};
+/* allow classroom debugging by researchers */
+const CLASSROOM = {
+  'no-console': 'off',
+  'no-debugger': 'warn',
+  'no-alert': 'warn',
+  'no-restricted-syntax': 'off'
+};
+/* turn off typescript recommendations */
+const HELP_TSJS = {
+  // 'no-undef': 'off', // TS handles this better; works with global types
+  'no-unused-vars': 'warn',
+  'no-shadow': 'off',
+  'no-param-reassign': 'off',
+  'object-curly-newline': 'off',
+  'react/jsx-props-no-spreading': 'off',
+  'arrow-body-style': 'off',
+  'no-plusplus': 'off',
+  'prefer-const': 'off',
+  'prefer-destructuring': 'off',
+  'class-methods-use-this': 'off',
+  'jsx-a11y/label-has-associated-control': 'off'
+};
+/* disable rules for material-ui sanity */
+const YUCK_MUI = {
+  'react/forbid-prop-types': 'off',
+  'react/prop-types': 'off'
+};
+/* disable prettier conflicts manually */
+const YUCK_PRETTIER = {
+  'arrow-parens': 'off'
+};
+/* these are our specific overrides of the recommended rules */
+const RULES = {
+  ...URSYS_STYLE,
+  ...CLASSROOM,
+  ...HELP_TSJS,
+  ...YUCK_MUI,
+  ...YUCK_PRETTIER
+};
+
+/// EXPORTS ///////////////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+module.exports = {
+  RULES
+};

.eslintrc-rules.js

@@ -0,0 +1,65 @@
+/*///////////////////////////////// ABOUT \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*\
+
+  ESLINT CONFIGURATION for NETCREATE ITEST (2023)
+
+\*\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\ * /////////////////////////////////////*/
+
+const { RULES } = require('./.eslintrc-rules');
+
+/// BASE CONFIGURATION ////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+const config = {
+  /*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*:
+    We want to support both node-style 'require' and es6 module 'import'.
+  :*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
+  env: {
+    browser: true,
+    es6: true,
+    node: true
+  },
+  plugins: ['react', '@typescript-eslint', 'import'],
+  /*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*:
+    Important: We use the official typescript-eslint/parser instead of the
+    default espree parser. This supercedes TSLINT as of 2019, and is supported
+    both by the Microsoft and ESLint teams.
+
+    The typescript parser handles the typescript superset syntax and creates a
+    compatible AST for ESLINT.
+  :*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
+  parser: '@typescript-eslint/parser',
+  ignorePatterns: ['**/_dist/*', '**/node_modules/*'],
+  parserOptions: {
+    'ecmaVersion': 2022,
+    'sourceType': 'module'
+  },
+  /*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*:
+    Plugins are packages that rules and sets of rules, but could also be
+    something else (e.g. parser) that ESLINT can make use of.
+    See: eslint.org/docs/user-guide/configuring#use-a-plugin
+  :*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
+  extends: [
+    'eslint:recommended', // standard recommendations
+    'plugin:react/recommended', // handle jsx syntax
+    'plugin:@typescript-eslint/eslint-recommended', // basic typescript rules
+    'prettier' // prettier overrides
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  settings: {
+    'react': {
+      'version': 'detect'
+    }
+  },
+  /*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*:
+    The "rules" field can override what was set in the "extends" field.
+    I am turning off the rules that I find annoying or trigger false warnings
+    in some code structures.
+  :*- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -*/
+  rules: RULES
+};
+
+/// EXPORTS ///////////////////////////////////////////////////////////////////
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+module.exports = config;

.eslintrc.js

@@ -5,34 +5,42 @@
 # or operating system, you probably want to add a global ignore instead:
 #   git config --global core.excludesfile ~/.gitignore
 
-# Ignore npm packaging
-/.node_modules
-/node_modules
+# NetCreate ignored directories
+/runtime
+netcreate-config.js
 
-# Ignore all logfiles and tempfiles.
+# _ur package
+_dist
+
+# Also ignore build system directories
+.npmignore
+/.parcel-cache
+/public*
+
+# the code-workspace file also hides node_modules from file list
+**/node_modules
+.package-lock.json
+
+# And don't commit personal log files or temp
+*_log.md
 *.log
-/tmp
+tmp-*
+*_nocommit
+
+# And don't commit .zip archives either
+*.zip
 
 # Ignore all generated files
 npm-debug.log
 *.tmproj
 
-# Ignore generated files in output folder
-/public
-
 # Numerous always-ignore extensions
 *~
 *.diff
 *.patch
 *.err
 *.orig
 *.log
-*.rej
-*.swo
-*.swp
-*.vi
-*~
-*.sass-cache
 
 # Ignore OS or Editor folders
 .DS_Store
@@ -42,10 +50,3 @@ npm-debug.log
 .tmproj
 nbproject
 Thumbs.db 
-
-# Ignore Sublime Text saved projects/workspaces 
-*.sublime-workspace
-*.sublime-project
-
-# Ignore JetBrains' IDEs
-.idea

.gitignore

@@ -0,0 +1 @@
+v18.18.2

.nvmrc

@@ -0,0 +1,16 @@
+/// PRETTIER //////////////////////////////////////////////////////////////////
+/*/- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\*\
+    Handles formatting on save to enforce code style. Works in conjunction with
+    ESLINT, which has to have its format-related rules disabled to not conflict
+    with Prettier.
+
+\*\- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /*/
+
+module.exports = {
+  semi: true,
+  printWidth: 86,
+  singleQuote: true,
+  quoteProps: 'preserve',
+  arrowParens: 'avoid',
+  trailingComma: 'none'
+};

.prettierignore

@@ -0,0 +1,55 @@
+# The following script is invoked on Apple OSX machines
+# in the .code-workspace setting "terminal.integrated.profiles.osx"
+
+#
+# (1) Ensure NVM Version is Obeyed in Shell
+#
+NODE_PREFERRED="v18.16.0"
+
+# ANSI Terminal Colors
+ALRT="\e[33;1m" # yellow
+INFO="\e[34;1m" # blue
+NRML="\e[0m"    # normal
+BOLD="\e[1m"    # normal bold
+
+# Check if NVM_DIR is defined
+if [ -z "$NVM_DIR" ]; then
+  echo ""
+  echo "vsenv: ${ALRT}NVM does not appear to be installed${NRML}"
+  echo "       Does your ${INFO}~/.zshrc${NRML} have ${INFO}export NVM_DIR${NRML} lines?"
+  echo ""
+  echo "       If you haven't installed nvm yet, please follow the instructions"
+  echo "       on the NetCreate wiki."
+  echo "       If you are using 'bash' as your default shell, you can copy "
+  echo "       these lines to your .zshrc file so nvm will also work in zsh."
+  return
+fi
+
+
+# Check if shell is opening inside a VSCODE integrated terminal
+# is NVM is installed, there is a .nvmrc file and a .vscode directory?
+if [ -n "$NVM_DIR" ] && [ -s "./.nvmrc" ] && [ -d "./.vscode" ]; then
+  NODE_VERSION=$(cat ./.nvmrc)
+  str_out="(nvm)";
+  str_alias=$(nvm alias default "$NODE_VERSION")
+  str_use=$(nvm use "$NODE_VERSION")
+  if [ -n "$str_use" ]; then
+    str_out="$str_out current version"
+  fi
+  if [ -n "$str_alias" ]; then
+    str_out="$str_out and alias"
+  fi
+  echo ""
+  echo "vsenv: VISUAL STUDIO CODE INTEGRATED TERMINAL DETECTED"
+  echo   "       ${str_out} detected setting: node ${INFO}$NODE_VERSION${NRML}"
+  CURRENT_VERSION=$(node --version)
+  if [ "$CURRENT_VERSION" != "$NODE_VERSION" ] && [ -n "$str_alias" ]; then
+    echo "vsenv: ${BOLD}kill/restart VSCODE for nvm alias default to take effect!${NRML}"
+    echo "       this shell is using version ${INFO}$CURRENT_VERSION${NRML} until you do"
+    echo "       alternatively, type ${ALRT}nvm use $NODE_VERSION${NRML} to use it now"
+  fi
+else
+  nvm use $NODE_PREFERRED > /dev/null 2>&1
+  nvm alias default $NODE_PREFERRED > /dev/null 2>&1
+  echo "zshrc: setting default node $NODE_PREFERRED"
+fi

.prettierrc.js

@@ -0,0 +1,18 @@
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": [
+    "editorconfig.editorconfig",
+    "dbaeumer.vscode-eslint",
+    "ms-vsliveshare.vsliveshare",
+    "esbenp.prettier-vscode",
+    "stkb.rewrap"
+  ],
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": [
+    "hookyqr.beautify",
+    "dbaeumer.jshint"
+  ]
+}