GitHub Action to find typos and lint Python code

Author: cclauss

.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+# This Action uses minimal steps to run in ~5 seconds to rapidly:
+# look for typos in the codebase using codespell, and
+# lint Python code using ruff and provide intuitive GitHub Annotations to contributors.
+# https://github.com/codespell-project/codespell#readme
+# https://docs.astral.sh/ruff/
+name: ci
+on:
+  push:
+    # branches: [main, master]
+  pull_request:
+    # branches: [main, master]
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: codespell-project/actions-codespell@v2
+      with:
+        ignore_words_list: blockin,dout,ethe,fo,reson,rin,shiftin,siz
+        skip: "*.min.js"
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: astral-sh/ruff-action@v3

Resampler.cpp

@@ -306,7 +306,7 @@ void Resampler::resample(float* input0, float* input1, uint16_t inputLength, uin
         }
     }
     if(outputCount < outputLength){
-        //ouput vector not full -> we ran out of input samples
+        //output vector not full -> we ran out of input samples
         processedLength=inputLength;
     }
     else{

Resampler.h

@@ -161,7 +161,7 @@ class Resampler {
                 }
             }
             if(outputCount < outputLength){
-                //ouput vector not full -> we ran out of input samples
+                //output vector not full -> we ran out of input samples
                 processedLength=inputLength;
             }
             else{

analyze_fft1024.cpp

@@ -97,7 +97,7 @@ void AudioAnalyzeFFT1024::update(void)
 	case 7:
 		blocklist[7] = block;
 		// TODO: perhaps distribute the work over multiple update() ??
-		//       github pull requsts welcome......
+		//       github pull requests welcome......
 		copy_to_fft_buffer(buffer+0x000, blocklist[0]->data);
 		copy_to_fft_buffer(buffer+0x100, blocklist[1]->data);
 		copy_to_fft_buffer(buffer+0x200, blocklist[2]->data);

analyze_tonedetect.cpp

@@ -153,7 +153,7 @@ AudioAnalyzeToneDetect::operator bool()
 
 	//Serial.printf("bool: power=%d, trig=%d\n", power, trigger);
 	return (power >= trigger);
-	// TODO: this should really remember if it's retuned true previously,
+	// TODO: this should really remember if it's returned true previously,
 	// so it can give a single true response each time a tone is seen.
 }
 

control_cs42448.cpp

@@ -127,7 +127,7 @@ bool AudioControlCS42448::inputLevelInteger(int32_t n)
 	return write(CS42448_DAC_Channel_Invert, data, 7);
 }
 
-bool AudioControlCS42448::inputLevelInteger(int chnnel, int32_t n)
+bool AudioControlCS42448::inputLevelInteger(int channel, int32_t n)
 {
 
 	return true;

control_cs42448.h

@@ -66,7 +66,7 @@ class AudioControlCS42448 : public AudioControl
 	bool volumeInteger(uint32_t n);
 	bool volumeInteger(int channel, uint32_t n);
 	bool inputLevelInteger(int32_t n);
-	bool inputLevelInteger(int chnnel, int32_t n);
+	bool inputLevelInteger(int channel, int32_t n);
 	// convert level to volume byte, section 6.9.1, page 50
 	uint32_t volumebyte(float level) {
 		if (level >= 1.0f) return 0;

control_tlv320aic3206.cpp

@@ -244,7 +244,7 @@ bool AudioControlTLV320AIC3206::setMicBias(int n) {
 }
 
 void AudioControlTLV320AIC3206::aic_reset() {
-  if (debugToSerial) Serial.println("INFO: Reseting AIC");
+  if (debugToSerial) Serial.println("INFO: Resetting AIC");
   aic_writePage(0x00, 0x01, 0x01);
   // aic_writeAddress(0x0001, 0x01);
 

effect_delay.h

@@ -83,7 +83,7 @@ class AudioEffectDelay : public AudioStream
 	}
 	void disable(uint8_t channel) {
 		if (channel >= 8) return;
-		// diable this channel
+		// disable this channel
 		activemask &= ~(1<<channel);
 		// recompute maxblocks for remaining enabled channels
 		recompute_maxblocks();

effect_granular.cpp

@@ -153,7 +153,7 @@ void AudioEffectGranular::update(void)
 				sample_req = false;
 				allow_len_change = true; // Reduces noise by not allowing the
 						// length to change after the sample has been
-						// recored.  Kind of not too much though
+						// recorded.  Kind of not too much though
 				if (write_head >= glitch_len) {
 					write_head = 0;
 					sample_loaded = true;
@@ -166,7 +166,7 @@ void AudioEffectGranular::update(void)
 
 			if (sample_loaded) {
 				//move it to the middle third of the bank.
-				//3 "seperate" banks are used
+				//3 "separate" banks are used
 				float fade_len = 20.00;
 				int16_t m2 = fade_len;