[pull] master from tldr-pages:master

.editorconfig

@@ -5,7 +5,7 @@ indent_style = space
 indent_size = 2
 end_of_line = lf
 charset = utf-8
-trim_trailing_whitespace = true
+trim_trailing_whitespace = false
 insert_final_newline = true
 
 [*.py]

.flake8

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 88
+# We ignore E501 as black handles it for us, and in a way that ignores strings
+# that go over the line length, as opposed to flake8 which flags such strings.
+extend-ignore = E203,E501

.gitattributes

@@ -1,8 +1,5 @@
-# This ensures that the line endings in any files added or modified are
-# normalized before being committed. On Windows they will automatically
-# be checked-out as CRLF, and re-converted to LF before check-in.
-# See https://git-scm.com/docs/gitattributes for more information.
-* text=auto
+# https://github.com/tldr-pages/tldr/issues/7097
+* text=auto eol=lf
 
 # GitHub linguist ignores markdown files by default, but tldr-pages
 # is mostly markdown, so we explicitly make the pages detectable

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Chat room
+    url: https://matrix.to/#/#tldr-pages:matrix.org
+    about: Consider joining the chat room to discuss your issue, question or suggestion with the community before opening an issue.

.github/ISSUE_TEMPLATE/page-request.yml

@@ -0,0 +1,27 @@
+name: 📄 Page request
+title: "page request: "
+description: Page request template.
+labels: new command, help wanted
+body:
+  - type: textarea
+    attributes:
+      label: Command description
+      description: Describe a command you want to be summarized.
+      placeholder: Tell us about the command!
+  - type: input
+    attributes:
+      label: Command details
+      description: Describe any details related to a command.
+      placeholder: e.g. command version
+  - type: checkboxes
+    attributes:
+      label: OS
+      description: Select which operating system(s) this command works with.
+      options:
+        - label: Android
+        - label: Linux
+        - label: macOS
+        - label: sunOS
+        - label: Windows
+
+

.github/ISSUE_TEMPLATE/page-translation.yml

@@ -0,0 +1,40 @@
+name: 📄 Page translation request
+title: "page translation: "
+description: Page translation request template.
+labels: translation
+body:
+  - type: textarea
+    attributes:
+      label: Command description
+      description: Describe a command you want to be translated.
+      placeholder: Tell us what TLDR page you want to see in your language!
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Command details
+      description: Describe any details related to a command.
+      placeholder: e.g. command version
+  - type: dropdown
+    attributes:
+      label: OS
+      description: Select an operating system category which this command falls into.
+      multiple: false
+      options:
+        - Linux
+        - Android
+        - macOS
+        - Windows
+        - General
+        - Other
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: OS details
+      description: Describe any details related to an operating system.
+      placeholder: |
+        e.g. OS version obtained via:
+        `uname -a` for Linux
+        `sw_vers` for macOS
+        `ver` for Windows

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,10 +1,12 @@
-<!-- Thank you for sending a PR! -->
-<!-- Please perform the following checks and mark all the boxes accordingly. -->
-<!-- You can remove the checklist items that don't apply to your PR. -->
+<!--
+Thank you for contributing!
+Please fill in the following checklist, removing items that do not apply.
+See also https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md
+-->
 
-- [ ] The page (if new), does not already exist in the repo.
-- [ ] The page is in the correct platform directory (`common/`, `linux/`, etc.)
-- [ ] The page has 8 or fewer examples.
-- [ ] The PR title conforms to the recommended [templates](/tldr-pages/tldr/blob/master/CONTRIBUTING.md#commit-message).
-- [ ] The page follows the [content guidelines](/tldr-pages/tldr/blob/master/CONTRIBUTING.md#guidelines).
-- [ ] The page description includes a link to documentation or a homepage (if applicable).
+- [ ] The page(s) are in the correct platform directories: `common`, `linux`, `osx`, `windows`, `sunos`, `android`, etc.
+- [ ] The page(s) have at most 8 examples.
+- [ ] The page description(s) have links to documentation or a homepage.
+- [ ] The page(s) follow the [content guidelines](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#guidelines).
+- [ ] The PR title conforms to the recommended [templates](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#commit-message).
+- **Version of the command being documented (if known):**

.github/codespell-ignore

@@ -0,0 +1 @@
+crate

.github/workflows/ci.yml

@@ -2,18 +2,27 @@ name: CI
 
 on: ['push', 'pull_request']
 
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
 jobs:
   ci:
     runs-on: ubuntu-latest
 
     name: CI
 
     steps:
+    - uses: actions/checkout@v3
+
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        cache: 'pip'
 
-    - name: Checkout
-      uses: actions/checkout@v2
+    - uses: actions/setup-node@v3
       with:
-        fetch-depth: 0
+        node-version: 'lts/*'
+        cache: 'npm'
 
     - name: Set up PR environment
       if: github.event.number != null
@@ -22,27 +31,22 @@ jobs:
     - name: Install npm dependencies
       run: npm ci
 
+    - name: Install pip dependencies
+      run: pip install -r requirements.txt -r scripts/pdf/requirements.txt
+
     - name: Test
       run: npm test
 
     - name: Build
       run: bash scripts/build.sh
 
-    - name: Setup Python for PDF generation
-      if: github.repository == 'tldr-pages/tldr' && github.ref == 'refs/heads/master'
-      uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-
     - name: Build PDF
-      if: github.repository == 'tldr-pages/tldr' && github.ref == 'refs/heads/master'
-      run: |
-        cd scripts/pdf/
-        pip3 install -r requirements.txt
-        python3 render.py ../../pages -c solarized-light
+      if: github.repository == 'tldr-pages/tldr' && github.ref == 'refs/heads/main'
+      working-directory: ./scripts/pdf
+      run: python render.py ../../pages -c solarized-light
 
     - name: Deploy
-      if: github.repository == 'tldr-pages/tldr' && github.ref == 'refs/heads/master'
+      if: github.repository == 'tldr-pages/tldr' && github.ref == 'refs/heads/main'
       run: bash scripts/deploy.sh
       env:
         DEPLOY_KEY: ${{ secrets.DEPLOY_KEY }}

.github/workflows/codespell.yml

@@ -0,0 +1,27 @@
+name: Codespell
+
+on: ['pull_request']
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/[email protected]
+        with:
+          # Ignore all other languages except English
+          files_ignore: |
+            pages.*/*/*
+            package-lock.json
+
+      - uses: codespell-project/actions-codespell@master
+        with:
+          ignore_words_file: .github/codespell-ignore
+          # Exit with 0 regardless of typos.
+          only_warn: 1
+          # Only check files in the PR
+          path: ${{ steps.changed-files.outputs.all_changed_files }}

.github/workflows/labeler.yml

@@ -0,0 +1,11 @@
+name: PR Labeler
+on: pull_request_target
+permissions:
+  pull-requests: write
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: tldr-pages/tldr-labeler-action@v0
+      with:
+        token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/mirror.yml

@@ -2,13 +2,17 @@ name: Main Mirror
 
 on:
   push:
-    branches: ['master']
+    branches: ['main']
 
+permissions: {}
 jobs:
   mirror:
+    permissions:
+      contents: write # to update branch 
+
     runs-on: ubuntu-latest
 
     steps:
       - uses: zofrex/mirror-branch@v1
         with:
-          target-branch: main
+          target-branch: master

.github/workflows/stale.yml

@@ -4,26 +4,38 @@ on:
   schedule:
   - cron: '0 0 * * *'
 
+permissions: {}
 jobs:
   stale:
+    permissions:
+      issues: write # to close stale issues (actions/stale)
+      pull-requests: write # to close stale PRs (actions/stale)
+
     runs-on: ubuntu-latest
 
     steps:
 
     - name: Stale Bot
-      uses: actions/stale@v3
+      uses: actions/stale@v8
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
 
         # Number of days of inactivity before an issue or PR is considered stale
-        days-before-stale: 15
+        days-before-pr-stale: 15
+
+        days-before-issue-stale: 45
+
 
         # Number of days of inactivity before a stale issue or PR is closed
-        days-before-close: 30
+        days-before-pr-close: 30
+
+        days-before-issue-close: 90 
 
         # Issues or PRs with these labels will never be considered stale
         exempt-pr-labels: stalebot ignore
 
+        exempt-issue-labels: stalebot ignore,help wanted
+
         # Label to use when marking an issue or PR as stale
         stale-pr-label: waiting
 
@@ -36,5 +48,5 @@ jobs:
         close-pr-message: |
           Hi everyone.
           This thread is being closed as there was no response to the previous prompt.
-          However, please leave a comment whenever you're ready to resume,
-          so the thread can be reopened. Thanks again!
+          However, please leave a comment whenever you're ready to resume, so the thread can be reopened.
+          Thanks again!

.gitignore

@@ -1,6 +1,9 @@
 # VS Code
 .vscode/
 
+# Jetbrains IDE
+.idea/
+
 # macOS filesystem custom folder attributes
 .DS_Store