Merge pull request #3 from docker/cm/eslint-prompts-part2

ESLint

Author: ColinMcNeil

functions/git/Dockerfile

@@ -0,0 +1,12 @@
+FROM alpine/git:latest
+
+# Add jq and bash
+RUN apk add --no-cache bash jq
+
+COPY scripts/git.sh /git.sh
+COPY scripts/extract.sh /extract.sh
+
+RUN chmod +x /git.sh
+RUN chmod +x /extract.sh
+
+ENTRYPOINT ["/git.sh"]

functions/git/README.md

@@ -0,0 +1,32 @@
+---
+extractors:
+  - image: vonwig/git:latest
+    entrypoint:
+      - /extract.sh
+functions:
+  - name: git_branch
+    description: Run git branch-related commands against a project
+    parameters:
+      type: object
+      properties:
+        command:
+          type: string 
+          description: The branch command. Either `branch`, `checkout` or `merge`. `rebase` can rewrite history and therefore should not be used.
+        args:
+          type: array
+          items: 
+            type: string
+            description: An argument to the git command
+    container:
+      image: vonwig/git:latest
+---
+
+# Background
+
+Git project information
+
+## Running the tool
+
+```sh
+docker build . -t vonwig/git:local
+```

functions/git/scripts/extract.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Git status. redirect stderr to stdout
+OUTPUT=$(git --no-pager status 2>&1)
+
+# If git status resulted in error, exit with it
+if [ $? -ne 0 ]; then
+    echo $(jq -n \
+        --arg output "$OUTPUT" \
+        '{git: $output}')
+    exit $?
+fi
+
+# Append git remote info
+OUTPUT="$OUTPUT\n\n$(git --no-pager remote -v)"
+
+# Append git branch info
+OUTPUT="$OUTPUT\n\n$(git --no-pager branch)"
+
+# Append git log info
+OUTPUT="$OUTPUT\n\n$(git --no-pager log -10 --oneline)"
+
+# Echo JSON project.git
+echo $(jq -n \
+    --arg output "$OUTPUT" \
+    '{git: $output}')
+

functions/git/scripts/git.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+echo "GOT ARGS $1"
+
+ARGS_JSON=$1
+
+# Get the arguments
+COMMAND=$(echo $ARGS_JSON | jq -r '.command')
+
+ARGS=$(echo $ARGS_JSON | jq -r '.args')
+
+# Run the command
+
+git $COMMAND $ARGS

functions/read_files/Dockerfile

@@ -0,0 +1,10 @@
+FROM alpine:latest
+
+# Add jq and bash
+RUN apk add --no-cache bash jq fd
+
+COPY scripts/read.sh /read.sh
+
+RUN chmod +x /read.sh
+
+ENTRYPOINT ["/read.sh"]

functions/read_files/README.md

@@ -0,0 +1,5 @@
+
+```sh
+docker build . -t vonwig/read_files
+docker run --mount type=bind,source=$PWD,target=/project --workdir /project vonwig/read_files '{"files":["Dockerfile"]}'
+```

functions/read_files/scripts/read.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+JSON_ARGS=$1
+
+# Read file paths array
+FILE_PATHS=$(echo $JSON_ARGS | jq -r '.files[]')
+
+for FILE_PATH in $FILE_PATHS; do
+    echo -e "Content for \`$FILE_PATH\`:\n\n\`\`\`\n"
+    # If file doesn't exist
+    if [ ! -f $FILE_PATH ]; then
+        echo "File $FILE_PATH does not exist"
+    else
+        # Print file content
+        cat $FILE_PATH
+    fi
+    echo -e "\n\`\`\`\n\n"
+done

prompts/eslint/010_system_prompt.md

@@ -1,50 +1,25 @@
-You are an assistant who specializes in making runbooks for setting up eslint in projects, allowing any developer to quickly improve their code quality.
+You are an assistant who specializes in linting JS/TS projects with ESLint and git. Follow the steps below.
 
-Since you are an expert and know about their project, be definitive about recommendations.
+The following is a report of the project's usage of ESLint and Typescript:
 
-A runbook for eslint looks like the following:
+{{project.eslint}}
 
-## Node Roots
-Pick the highest level node root. Ideally, it will be at `./`.
+## Pick Linter
+If there are no ESLint configuration files found, use StandardJS to lint the project.
 
-Since node roots are required, if there are no node roots, you need to recommend 
+## Linter Args
+When using StandardJS, use typescript arg only if tsconfigs are reported.
+If there is an ESLint config, lint the project using the right version of ESLint. Use a glob for `.ts`, `.js`, `.tsx`, and `.jsx`
 
-```sh
-npm init
-```
+## Lint Steps
 
-If there aren't any node roots at top level, you should recommend opening a specific folder.
+Do the following to lint a JS/TS project:
 
-## Check for eslint config
+1. Create a new branch with git.
 
-If the project files contain eslint config files such as .eslintrc already, you should skip the steps to get eslint and write configs.
+2. Run the linter chosen, fixing violations.
 
-## Get eslint
+3. Evaluate the report of remaining violations after autofix. 
 
-```sh
-npm install --save-dev eslint eslint-config-recommended
-```
-
-## Write configs
-
-The eslint-config-recommended provides the following:
-    - recommended/esnext
-    - recommended/esnext/style-guide
-    - recommended/node
-    - recommended/node/style-guide
-    - recommended/react-native
-    - recommended/react-native/style-guide
-
-Based on the user's project files, pick the config and style guide to use.
-
-```sh
-echo "extends:\n  - recommended/config\n  - recommended/config/style-guide" > .eslintrc.yaml
-```
-
-## Lint
-
-```sh
-npx --no-install eslint .
-```
-
-Your runbooks should be adjusted for the user's project but overall match that format.
+4. Read files affected and generate fixes for the remaining violations.
+    

prompts/eslint/020_user_prompt.md

@@ -1,22 +1,3 @@
-Hi, I need a runbook to get started with eslint.
+Lint my project's JS/TS files. Use branch linting-eslint or a different one if it exists.
 
-I'm on {{platform}} architecture.
-
-My project files are:
-
-{{project.files}}
-
-I have the following node roots:
-
-{{#project.node_roots}}
-  --- Node Root ---
-  My project has a node root package.json at {{path}} and uses node version {{version}}.
-  The node root has the following scripts
-  {{scripts}}
-  -----------------
-{{/project.node_roots}}
-{{^project.node_roots}}
-  Actually, the project does not have a node root, so help me run `npm init`
-{{/project.node_roots}}
-
-Can you help?
+Report what you did, broken down by each tool.

prompts/eslint/Dockerfile

@@ -1,10 +1,15 @@
-# ESLint Config Extractor
+FROM node:lts-alpine3.20
 
-FROM alpine:latest
+# Add jq and bash
+RUN apk add --no-cache bash jq
 
-# Add bash, fd
-RUN apk add --no-cache bash fd
+ENTRYPOINT ["/lint.sh"]
 
-COPY scripts/detect-eslint.sh /detect-eslint.sh
+# Install eslint versions 6-9
+RUN npm install -g eslint@6 eslint@7 eslint@8 eslint@9 typescript typescript-eslint
 
-CMD ["bash", "/detect-eslint.sh"]
+COPY scripts/lint.sh /lint.sh
+COPY scripts/remap_lint.sh /remap_lint.sh
+
+RUN chmod +x /lint.sh
+RUN chmod +x /remap_lint.sh