Merge branch 'main' into async

DaveSkender · Jan 1, 2024 · 92443f3 · 92443f3
2 parents c68046d + 17d5ab8
commit 92443f3
Show file tree

Hide file tree

Showing 87 changed files with 159 additions and 89 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -58,4 +58,4 @@ jobs:
           accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
           projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
           directory: docs/_site
-          wranglerVersion: '3'
+          wranglerVersion: 'latest'
diff --git a/.github/workflows/docs-test-links.yml b/.github/workflows/docs-test-links.yml
@@ -68,6 +68,6 @@ jobs:
         run: |
           htmlproofer _site \
             --no-enforce-https \
-            --ignore-status-codes "403,406,408,429,503,999" \
+            --ignore-status-codes "0,403,406,408,429,503,999" \
             --swap-urls "https\://dotnet.stockindicators.dev:http\://127.0.0.1:4000" \
             --ignore-urls "/fonts.gstatic.com/"
diff --git a/.github/workflows/semantic-pr-linter.yml b/.github/workflows/semantic-pr-linter.yml
@@ -0,0 +1,70 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  pull-requests: write
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        id: lint_pr_title
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+
+          # Configure additional validation for the subject based on a regex.
+          # We enforce that the subject starts with an uppercase character.
+          subjectPattern: ^([A-Z]).+$
+
+          # If `subjectPattern` is configured, you can use this property to override
+          # the default error message that is shown when the pattern doesn't match.
+          # The variables `subject` and `title` can be used within the message.
+          subjectPatternError: >
+            The subject "**{subject}**" found in the pull request title "*{title}*"
+            didn't match the configured pattern. Please ensure that the subject
+            starts with an uppercase character.
+
+          # If the PR contains one of these newline-delimited labels, the
+          # validation is skipped. If you want to rerun the validation when
+          # labels change, you might want to use the `labeled` and `unlabeled`
+          # event triggers in your workflow.
+          ignoreLabels: |
+            bot
+            ignore-semantic-pull-request
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        # When the previous steps fails, the workflow would stop. By adding this
+        # condition you can continue the execution with the populated error message.
+        if: always() && (steps.lint_pr_title.outputs.error_message != null)
+        with:
+          header: pr-title-lint-error
+          message: >
+            ### Hey there and thank you for opening this pull request! 👋🏼
+
+            It looks like your proposed **_Pull request title_** needs to be adjusted.
+
+            >🚩 **ERROR:** ${{ steps.lint_pr_title.outputs.error_message }}
+
+            #### Pull request title naming convention
+
+            Our PR title name taxonomy is `type: Subject`, where **type** is typically
+            *feat*, *fix*, or *chore* and **subject** is a noun that starts with a capitalized letter.
+            The *chore* type usually has a subject that starts with an action verb like *Add* or *Update*.
+            Examples: `feat: Admin portal login`, `fix: Divide by zero bug in SMA`, and `chore: Update user docs`.
+            See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information.
+
+      # Delete a previous comment when the issue has been resolved
+      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          header: pr-title-lint-error
+          delete: true
diff --git a/docs/_indicators/Adl.md b/docs/_indicators/Adl.md
@@ -15,7 +15,7 @@ Created by Marc Chaikin, the [Accumulation/Distribution Line/Index](https://en.w
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<AdlResult> results =
   quotes.GetAdl();
 

diff --git a/docs/_indicators/Adx.md b/docs/_indicators/Adx.md
@@ -15,7 +15,7 @@ Created by J. Welles Wilder, the Directional Movement Index (DMI) and [Average D
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<AdxResult> results =
   quotes.GetAdx(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Alligator.md b/docs/_indicators/Alligator.md
@@ -15,7 +15,7 @@ Created by Bill Williams, Alligator is a depiction of three smoothed moving aver
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<AlligatorResult> results =
   quotes.GetAlligator(jawPeriods,jawOffset,teethPeriods,teethOffset,lipsPeriods,lipsOffset);
 ```

diff --git a/docs/_indicators/Alma.md b/docs/_indicators/Alma.md
@@ -15,7 +15,7 @@ Created by Arnaud Legoux and Dimitrios Kouzis-Loukas, [ALMA]({{site.github.repos
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<AlmaResult> results =
   quotes.GetAlma(lookbackPeriods, offset, sigma);
 ```

diff --git a/docs/_indicators/Aroon.md b/docs/_indicators/Aroon.md
@@ -15,7 +15,7 @@ Created by Tushar Chande, [Aroon](https://school.stockcharts.com/doku.php?id=tec
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<AroonResult> results =
   quotes.GetAroon(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Atr.md b/docs/_indicators/Atr.md
@@ -15,7 +15,7 @@ Created by J. Welles Wilder, True Range and [Average True Range](https://en.wiki
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// standard usage
+// C# usage syntax
 IEnumerable<AtrResult> results =
   quotes.GetAtr(lookbackPeriods);
 

diff --git a/docs/_indicators/AtrStop.md b/docs/_indicators/AtrStop.md
@@ -15,7 +15,7 @@ Created by Welles Wilder, the ATR Trailing Stop indicator attempts to determine
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<AtrStopResult> results =
   quotes.GetAtrStop(lookbackPeriods, multiplier, endType);
 ```

diff --git a/docs/_indicators/Awesome.md b/docs/_indicators/Awesome.md
@@ -15,7 +15,7 @@ Created by Bill Williams, the Awesome Oscillator (aka Super AO) is a measure of
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<AwesomeResult> results =
   quotes.GetAwesome(fastPeriods, slowPeriods);
 ```

diff --git a/docs/_indicators/BasicQuote.md b/docs/_indicators/BasicQuote.md
@@ -11,7 +11,7 @@ layout: indicator
 Returns a basic quote transform (e.g. HL2, OHL3, etc.) and isolation of individual price quote candle parts from a full OHLCV quote.
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<BasicData> results =
   quotes.GetBaseQuote(candlePart);
 ```

diff --git a/docs/_indicators/Beta.md b/docs/_indicators/Beta.md
@@ -15,7 +15,7 @@ layout: indicator
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<BetaResult> results = quotesEval
   .GetBeta(quotesMarket, lookbackPeriods, type);
 ```

diff --git a/docs/_indicators/BollingerBands.md b/docs/_indicators/BollingerBands.md
@@ -15,7 +15,7 @@ Created by John Bollinger, [Bollinger Bands](https://en.wikipedia.org/wiki/Bolli
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<BollingerBandsResult> results =
   quotes.GetBollingerBands(lookbackPeriods, standardDeviations);
 ```

diff --git a/docs/_indicators/Bop.md b/docs/_indicators/Bop.md
@@ -15,7 +15,7 @@ Created by Igor Levshin, the [Balance of Power](https://school.stockcharts.com/d
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<BopResult> results =
   quotes.GetBop(smoothPeriods);
 ```

diff --git a/docs/_indicators/Cci.md b/docs/_indicators/Cci.md
@@ -15,7 +15,7 @@ Created by Donald Lambert, the [Commodity Channel Index](https://en.wikipedia.or
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<CciResult> results =
   quotes.GetCci(lookbackPeriods);
 ```

diff --git a/docs/_indicators/ChaikinOsc.md b/docs/_indicators/ChaikinOsc.md
@@ -15,7 +15,7 @@ Created by Marc Chaikin, the [Chaikin Oscillator](https://en.wikipedia.org/wiki/
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<ChaikinOscResult> results =
   quotes.GetChaikinOsc(fastPeriods, slowPeriods);
 ```

diff --git a/docs/_indicators/Chandelier.md b/docs/_indicators/Chandelier.md
@@ -16,7 +16,7 @@ Created by Charles Le Beau, the [Chandelier Exit](https://school.stockcharts.com
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<ChandelierResult> results =
   quotes.GetChandelier(lookbackPeriods, multiplier, type);
 ```

diff --git a/docs/_indicators/Chop.md b/docs/_indicators/Chop.md
@@ -14,7 +14,7 @@ Created by E.W. Dreiss, the Choppiness Index measures the trendiness or choppine
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<ChopResult> results =
   quotes.GetChop(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Cmf.md b/docs/_indicators/Cmf.md
@@ -15,7 +15,7 @@ Created by Marc Chaikin, [Chaikin Money Flow](https://en.wikipedia.org/wiki/Chai
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<CmfResult> results =
   quotes.GetCmf(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Cmo.md b/docs/_indicators/Cmo.md
@@ -15,7 +15,7 @@ Created by Tushar Chande, the [Chande Momentum Oscillator](https://www.investope
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<CmoResult> results =
   quotes.GetCmo(lookbackPeriods);
 ```

diff --git a/docs/_indicators/ConnorsRsi.md b/docs/_indicators/ConnorsRsi.md
@@ -15,7 +15,7 @@ Created by Laurence Connors, the [ConnorsRSI](https://alvarezquanttrading.com/wp
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<ConnorsRsiResult> results =
   quotes.GetConnorsRsi(rsiPeriods, streakPeriods, rankPeriods);
 ```

diff --git a/docs/_indicators/Correlation.md b/docs/_indicators/Correlation.md
@@ -15,7 +15,7 @@ Created by Karl Pearson, the [Correlation Coefficient](https://en.wikipedia.org/
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<CorrResult> results =
   quotesA.GetCorrelation(quotesB, lookbackPeriods);
 ```

diff --git a/docs/_indicators/Dema.md b/docs/_indicators/Dema.md
@@ -17,7 +17,7 @@ Created by Patrick G. Mulloy, the [Double exponential moving average](https://en
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<DemaResult> results =
   quotes.GetDema(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Doji.md b/docs/_indicators/Doji.md
@@ -15,7 +15,7 @@ type: candlestick-pattern
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<CandleResult> results =
   quotes.GetDoji(maxPriceChangePercent);
 ```

diff --git a/docs/_indicators/Donchian.md b/docs/_indicators/Donchian.md
@@ -16,7 +16,7 @@ Created by Richard Donchian, [Donchian Channels](https://en.wikipedia.org/wiki/D
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<DonchianResult> results =
   quotes.GetDonchian(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Dpo.md b/docs/_indicators/Dpo.md
@@ -15,7 +15,7 @@ layout: indicator
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<DpoResult> results =
   quotes.GetDpo(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Dynamic.md b/docs/_indicators/Dynamic.md
@@ -15,7 +15,7 @@ Created by John R. McGinley, the [McGinley Dynamic](https://www.investopedia.com
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage (with Close price)
+// C# usage syntax (with Close price)
 IEnumerable<DynamicResult> results =
   quotes.GetDynamic(lookbackPeriods, kFactor);
 ```

diff --git a/docs/_indicators/ElderRay.md b/docs/_indicators/ElderRay.md
@@ -15,7 +15,7 @@ Created by Alexander Elder, the [Elder-ray Index](https://www.investopedia.com/t
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<ElderRayResult> results =
   quotes.GetElderRay(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Ema.md b/docs/_indicators/Ema.md
@@ -15,7 +15,7 @@ layout: indicator
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage (with Close price)
+// C# usage syntax (with Close price)
 IEnumerable<EmaResult> results =
   quotes.GetEma(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Epma.md b/docs/_indicators/Epma.md
@@ -15,7 +15,7 @@ Endpoint Moving Average (EPMA), also known as Least Squares Moving Average (LSMA
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<EpmaResult> results =
   quotes.GetEpma(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Fcb.md b/docs/_indicators/Fcb.md
@@ -15,7 +15,7 @@ Created by Edward William Dreiss, Fractal Chaos Bands outline high and low price
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<FcbResult> results =
   quotes.GetFcb(windowSpan);
 ```

diff --git a/docs/_indicators/FisherTransform.md b/docs/_indicators/FisherTransform.md
@@ -15,7 +15,7 @@ Created by John Ehlers, the [Fisher Transform](https://www.investopedia.com/term
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<FisherTransformResult> results =
   quotes.GetFisherTransform(lookbackPeriods);
 ```

diff --git a/docs/_indicators/ForceIndex.md b/docs/_indicators/ForceIndex.md
@@ -15,7 +15,7 @@ Created by Alexander Elder, the [Force Index](https://en.wikipedia.org/wiki/Forc
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<ForceIndexResult> results =
   quotes.GetForceIndex(lookbackPeriods);
 ```

diff --git a/docs/_indicators/Fractal.md b/docs/_indicators/Fractal.md
@@ -15,7 +15,7 @@ Created by Larry Williams, [Fractal](https://www.investopedia.com/terms/f/fracta
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<FractalResult> results =
   quotes.GetFractal(windowSpan);
 ```

diff --git a/docs/_indicators/Gator.md b/docs/_indicators/Gator.md
@@ -15,7 +15,7 @@ Created by Bill Williams, the Gator Oscillator is an expanded oscillator view of
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<GatorResult> results =
   quotes.GetGator();
 

diff --git a/docs/_indicators/HeikinAshi.md b/docs/_indicators/HeikinAshi.md
@@ -15,7 +15,7 @@ Created by Munehisa Homma, [Heikin-Ashi](https://en.wikipedia.org/wiki/Candlesti
 ![chart for {{page.title}}]({{site.baseurl}}{{page.image}})
 
 ```csharp
-// usage
+// C# usage syntax
 IEnumerable<HeikinAshiResult> results =
   quotes.GetHeikinAshi();
 ```